python-template
A cookiecutter package with UCL ARC recommendations.
Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Repository
A cookiecutter package with UCL ARC recommendations.
Basic Info
- Host: GitHub
- Owner: acgs0324
- License: other
- Language: Python
- Default Branch: main
- Size: 19.5 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Python Template
A cookiecutter package with UCL ARC recommendations.
This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.
About
Project Team
Angus Cheung (anguscheungangus@gmail.com)
Research Software Engineering Contact
Centre for Advanced Research Computing, University College London (arc.collaborations@ucl.ac.uk)
Built With
Getting Started
Prerequisites
python-template requires Python 3.10–3.12.
Installation
We recommend installing in a project specific virtual environment created using
a environment management tool such as
Conda. To install the latest
development version of python-template using pip in the currently active
environment run
sh
pip install git+https://github.com/acgs0324/python-template.git
Alternatively create a local clone of the repository with
sh
git clone https://github.com/acgs0324/python-template.git
and then install in editable mode by running
sh
pip install -e .
Running Locally
How to run the application on your local system.
Running Tests
Tests can be run across all compatible Python versions in isolated environments
using tox by running
sh
tox
To run tests manually in a Python environment with pytest installed run
sh
pytest tests
again from the root of the repository.
Building Documentation
The MkDocs HTML documentation can be built locally by running
sh
tox -e docs
from the root of the repository. The built documentation will be written to
site.
Alternatively to build and preview the documentation locally, in a Python
environment with the optional docs dependencies installed, run
sh
mkdocs serve
Roadmap
- [x] Initial Research
- [ ] Minimum viable product <-- You are Here
- [ ] Alpha Release
- [ ] Feature-Complete Release
Acknowledgements
This work was funded by a grant from the UCL-ARC.
Owner
- Name: Angus Cheung
- Login: acgs0324
- Kind: user
- Repositories: 1
- Profile: https://github.com/acgs0324
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
authors:
- family-names: "Cheung"
given-names: "Angus"
email: "anguscheungangus@gmail.com"
repository-code: "https://github.com/acgs0324/python-template"
title: "Python Template: A cookiecutter package with UCL ARC recommendations."
license: "BSD-3"
GitHub Events
Total
Last Year
Dependencies
- actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
- actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
- peaceiris/actions-gh-pages 4f9cc6602d3f66b9c108549d475ec49e8ef4d45e composite
- actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
- actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
- actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
- actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite