python-template
python-template copied to clipboard
NLeSC
584-allow uppercase in package name
Checklist before requesting a review
- [x] I have read the contribution guidelines
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] All user facing changes have been added to CHANGELOG.md
Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
List of related issues or pull requests**
Refs:
- #584
Describe the changes made in this pull request
Package names containing uppercase are allowed.
Instructions to review the pull request
Install the requirements
cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier
Create a new package using the template
copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package
Create a local git repo to push to GitHub to trigger CI actions
git init
git add --all
git commit -m "First commit"
git remote add origin [email protected]:<YOU>/python-template-test.git
git push -u origin main -f
# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'
