Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cthoyt/animated_barnacle
May Institute Demo 2024
https://github.com/cthoyt/animated_barnacle
Last synced: about 1 month ago
JSON representation
May Institute Demo 2024
- Host: GitHub
- URL: https://github.com/cthoyt/animated_barnacle
- Owner: cthoyt
- License: mit
- Created: 2024-05-07T17:53:57.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-07T18:42:12.000Z (6 months ago)
- Last Synced: 2024-06-13T20:30:31.944Z (5 months ago)
- Language: Python
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
Animated Barnacle
This is a test package.
## 💪 Getting Started
> TODO show in a very small amount of space the **MOST** useful thing your package can do.
> Make it as short as possible! You have an entire set of docs for later.
### Command Line Interface
The animated_barnacle command line tool is automatically installed. It can
be used from the shell with the `--help` flag to show all subcommands:
```shell
animated_barnacle --help
```
> TODO show the most useful thing the CLI does! The CLI will have documentation auto-generated
> by `sphinx`.
## 🚀 Installation
The most recent code and data can be installed directly from GitHub with:
```shell
pip install git+https://github.com/cthoyt/animated_barnacle.git
```
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See
[CONTRIBUTING.md](https://github.com/cthoyt/animated_barnacle/blob/master/.github/CONTRIBUTING.md)
for more information on getting involved.
## 👋 Attribution
### ⚖️ License
The code in this package is licensed under the MIT License.
### 🍪 Cookiecutter
This package was created with [@audreyfeldroy](https://github.com/audreyfeldroy)'s
[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using [@cthoyt](https://github.com/cthoyt)'s
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack) template.
## 🛠️ For Developers
See developer instructions
The final section of the README is for if you want to get involved by making a code contribution.
### Development Installation
To install in development mode, use the following:
```bash
git clone git+https://github.com/cthoyt/animated_barnacle.git
cd animated_barnacle
pip install -e .
```
### Updating Package Boilerplate
This project uses `cruft` to keep boilerplate (i.e., configuration, contribution guidelines, documentation
configuration)
up-to-date with the upstream cookiecutter package. Update with the following:
```shell
pip install cruft
cruft update
```
More info on Cruft's update command is
available [here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).
### 🥼 Testing
After cloning the repository and installing `tox` and `tox-uv` with `pip install tox tox-uv`,
the unit tests in the `tests/` folder can be run reproducibly with:
```shell
tox
```
Additionally, these tests are automatically re-run with each commit in a
[GitHub Action](https://github.com/cthoyt/animated_barnacle/actions?query=workflow%3ATests).
### 📖 Building the Documentation
The documentation can be built locally using the following:
```shell
git clone git+https://github.com/cthoyt/animated_barnacle.git
cd animated_barnacle
tox -e docs
open docs/build/html/index.html
```
The documentation automatically installs the package as well as the `docs`
extra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins
like `texext` can be added there. Additionally, they need to be added to the
`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using
[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
The [`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration you'll need.
You can also set up continuous integration on GitHub to check not only that
Sphinx can build the documentation in an isolated environment (i.e., with ``tox -e docs-test``)
but also that [ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).
### 📦 Making a Release
After installing the package in development mode and installing `tox` and `tox-uv` with `pip install tox tox-uv`,
the commands for making a new release are contained within the `finish` environment
in `tox.ini`. Run the following from the shell:
```shell
tox -e finish
```
This script does the following:
1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the version number in
the `setup.cfg`, `CITATION.cff`, `src/animated_barnacle/version.py`,
and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix
2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build)
3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to have a `.pypirc` file
configured to avoid the need for manual input at this step
4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use `tox -e bumpversion -- minor` after.