Comments (5)
from style-guides.
For what it's worth, here is the style guide that is used for the jwql
project. It doesn't discuss packaging practices, but perhaps a decent starting point?
from style-guides.
Various relatively minor points on the current draft Python style guide.
- "The Python ecosystem is shared one". Missing word 'a' before 'shared'.
- "opeinging up Python" Typo
- In the Style section, there is inconsistent language. The first paragraph says that the PEP8 guidelines "are not absolutes, but rather guidelines". But immediately after that it says "The following exceptions are allowed" which implies no other exceptions are allowed at all.
- "should have automatically build documentation" should say 'built' instead
- "hosted automatically on servcies like ReadTheDocs or internal STScI services." First, 'servcies' has a typo. Secondly I would be interested in hearing more about the internal service options for doc hosting; is there any internal equivalent to readthedocs for hosting documentation from projects on Gitlab? If so it would be good to provide a how-to for that here, or link to that info elsewhere.
- "documnentation" typo.
- I agree with the statement that notebooks in the docs should be included in the automatically built docs! This could helpfully refer to the
nbsphinx
Sphinx extension in addition to plainnbconvert
. - In the recommended template packages it says "astropy template package with STSci specific changes", but does not explain what specific changes are intended.
from style-guides.
Re: nbconvert
-- It does add onto maintenance burden, especially if you host it on RTD, as it requires more than sphinx
as doc build dependencies, and requires those to play well with RTD. For example, if your notebooks take too long to render, you might run over the 900s limit (or is it 450s?) on RTD server and get timed out error.
from style-guides.
This issue is too broad. There are now several pages on different aspects of Python coding and packaging. Any remaining concerns should be separate issue(s).
from style-guides.
Related Issues (20)
- Web style guide should link to branding page
- Add astroconda to release guide
- Microservices style guide HOT 1
- Testing style guide: Discourage Travis CI, find replacement? HOT 2
- Add information about how to cite software HOT 1
- Notebook style guide: Footer instruction confusing HOT 1
- Review security style guide HOT 2
- Community Name for Zenodo Software DOI? HOT 1
- Detailed Zenodo instructions for new software DOI? HOT 1
- This thing needs to be managed and advertised HOT 2
- Present this in TIPS and EngOps in 2020 HOT 1
- Badge for packages that follow style guide HOT 2
- Distribute flyers around STScI HOT 1
- Update python packaging information
- Organize a hack day in 2020 HOT 1
- Create a ROADMAP
- Ditch Travis CI as a recommended solution HOT 4
- Update Master Branch
- Notebook accessibility from Scipy 2023
- Adopt the Scientific Python Developers Guide
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from style-guides.