python-project-template
Python project best practices for scientific software
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
✓Academic publication links
Links to: iop.org, zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary
Keywords
Repository
Python project best practices for scientific software
Basic Info
- Host: GitHub
- Owner: lincc-frameworks
- License: bsd-3-clause
- Language: Jinja
- Default Branch: main
- Homepage: https://lincc-ppt.readthedocs.io/
- Size: 746 KB
Statistics
- Stars: 72
- Watchers: 10
- Forks: 17
- Open Issues: 20
- Releases: 35
Topics
Metadata Files
README.md
LINCC Frameworks Python Project Template
This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation. It is meant to help new python projects get started quickly, letting the user focus on writing code. The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over. You can read more in the PPT research note.
Copier is required to use this template. Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. It's really neat!
Our template works best with Copier v9.1 and above. For all the information, see the detailed user guide in readthedocs
Getting started
Choose where you would like to create your new project, and call copier with the template.
```sh
copier copy gh:lincc-frameworks/python-project-template
Create a virtual environment, feel free to use conda, pyenv or your favorite tool
python3 -mvenv ~/.virtualenvs/
Contributing to the Template
See full documentation at readthedocs
Citation
If you use Python Project Template in your work, we ask the you cite the "A Python Project Template for Healthy Scientific Software" research note full citation:
Acknowledgements
This project is supported by Schmidt Sciences.
Owner
- Name: lincc-frameworks
- Login: lincc-frameworks
- Kind: organization
- Repositories: 5
- Profile: https://github.com/lincc-frameworks
Citation (CITATION.bib)
@ARTICLE{2024RNAAS...8..141O,
author = {{Oldag}, Drew and {DeLucchi}, Melissa and {Beebe}, Wilson and {Branton}, Doug and {Campos}, Sandro and {Chandler}, Colin Orion and {Christofferson}, Carl and {Connolly}, Andrew and {Kubica}, Jeremy and {Lynn}, Olivia and {Malanchev}, Konstantin and {Malz}, Alex I. and {Mandelbaum}, Rachel and {McGuire}, Sean and {Wenneman}, Chris},
title = "{A Python Project Template for Healthy Scientific Software}",
journal = {Research Notes of the American Astronomical Society},
keywords = {Open source software, 1866},
year = 2024,
month = may,
volume = {8},
number = {5},
eid = {141},
pages = {141},
doi = {10.3847/2515-5172/ad4da1},
adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8..141O},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
GitHub Events
Total
- Create event: 19
- Release event: 3
- Issues event: 36
- Watch event: 8
- Delete event: 18
- Issue comment event: 37
- Push event: 23
- Pull request review comment event: 12
- Pull request review event: 23
- Pull request event: 28
- Fork event: 1
Last Year
- Create event: 19
- Release event: 3
- Issues event: 36
- Watch event: 8
- Delete event: 18
- Issue comment event: 37
- Push event: 23
- Pull request review comment event: 12
- Pull request review event: 23
- Pull request event: 28
- Fork event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 19
- Total pull requests: 9
- Average time to close issues: 7 months
- Average time to close pull requests: 9 days
- Total issue authors: 6
- Total pull request authors: 5
- Average comments per issue: 0.89
- Average comments per pull request: 0.22
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 14
- Pull requests: 9
- Average time to close issues: about 2 months
- Average time to close pull requests: 9 days
- Issue authors: 6
- Pull request authors: 5
- Average comments per issue: 0.43
- Average comments per pull request: 0.22
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- hombit (31)
- delucchi-cmu (29)
- drewoldag (18)
- kdesoto-astro (2)
- OliviaLynn (2)
- camposandro (2)
- jeremykubica (1)
- alefisico (1)
- ssteinerx (1)
- mschwamb (1)
- biprateep (1)
- krose098 (1)
- sylvielsstfr (1)
- evevkovacs (1)
- mabruzzo (1)
Pull Request Authors
- delucchi-cmu (29)
- drewoldag (20)
- camposandro (14)
- hombit (8)
- mtauraso (6)
- jeremykubica (5)
- smcguire-cmu (3)
- OliviaLynn (3)
- dependabot[bot] (3)
- dougbrn (1)
- ztq1996 (1)