Generated from aind-library-template
Project description
aind-dynamic-foraging-basic-analysis
Usage
- To use this template, click the green
Use this template
button andCreate new repository
. - After github initially creates the new repository, please wait an extra minute for the initialization scripts to finish organizing the repo.
- To enable the automatic semantic version increments: in the repository go to
Settings
andCollaborators and teams
. Click the greenAdd people
button. Addsvc-aindscicomp
as an admin. Modify the file in.github/workflows/tag_and_publish.yml
and remove the if statement in line 10. The semantic version will now be incremented every time a code is committed into the main branch. - To publish to PyPI, enable semantic versioning and uncomment the publish block in
.github/workflows/tag_and_publish.yml
. The code will now be published to PyPI every time the code is committed into the main branch. - The
.github/workflows/test_and_lint.yml
file will run automated tests and style checks every time a Pull Request is opened. If the checks are undesired, thetest_and_lint.yml
can be deleted. The strictness of the code coverage level, etc., can be modified by altering the configurations in thepyproject.toml
file and the.flake8
file.
Installation
To use the software, in the root directory, run
pip install -e .
To develop the code, run
pip install -e .[dev]
Contributing
Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
- Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
- Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
- Use black to automatically format the code into PEP standards:
black .
- Use isort to automatically sort import statements:
isort .
Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bugfix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Semantic Release
The table below, from semantic release, shows which commit message gets you which release type when semantic-release
runs (using the default configuration):
Commit message | Release type |
---|---|
fix(pencil): stop graphite breaking when too much pressure applied |
|
feat(pencil): add 'graphiteWidth' option |
|
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons. |
(Note that the BREAKING CHANGE: token must be in the footer of the commit) |
Documentation
To generate the rst files source files for documentation, run
sphinx-apidoc -o doc_template/source/ src
Then to create the documentation HTML files, run
sphinx-build -b html doc_template/source/ doc_template/build/html
More info on sphinx installation can be found here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aind_dynamic_foraging_basic_analysis-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c272d64ae942ba718459ebbee3635f0d1300365376c0cb800f466bf25d3460af |
|
MD5 | b50e2b8c505e860e5dfe996b98b85689 |
|
BLAKE2b-256 | 28d909818df9a659e1c09b856ff7feace7eca3ea1cef54d57db6637e2babaf25 |
Hashes for aind_dynamic_foraging_basic_analysis-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38f13a07fdc35346d1f0e81937a1bef010c7f0eec31de7b6f16567818ea86c69 |
|
MD5 | be9eea41d6a5dd5ee1a647fe55fcaad4 |
|
BLAKE2b-256 | e032ce9bf427eb568eaac79a58d55f4b0d9075175a1c759bed9e8831f2a3c440 |