An example library
Project description
template-test-repo
An example library
Usage
TODO: Use this section to explain how someone would use your package in their project. For example: how to add the package to a project as a requirement, how to configure the package, how to initialize the package, and how to call it.
Hacking
Installing template-test-repo in a development environment
You will need
-
pyenv Follow the instructions in the pyenv README to install it. The Homebrew method works best on macOS. On Ubuntu follow the Basic GitHub Checkout method.
Clone the git repo
git clone https://github.com/hypothesis/template-test-repo.git
This will download the code into a template-test-repo
directory
in your current working directory. You need to be in the
template-test-repo
directory for the rest of the installation
process:
cd template-test-repo
Run the tests
make test
That's it! You’ve finished setting up your template-test-repo
development environment. Run make help
to see all the commands that're
available for linting, code formatting, packaging, etc.
Updating the Cookiecutter scaffolding
This project was created from the https://github.com/hypothesis/h-cookiecutter-pypackage/ template. If h-cookiecutter-pypackage itself has changed since this project was created, and you want to update this project with the latest changes, you can "replay" the cookiecutter over this project. Run:
make template
This will change the files in your working tree, applying the latest updates from the h-cookiecutter-pypackage template. Inspect and test the changes, do any fixups that are needed, and then commit them to git and send a pull request.
If you want make template
to skip certain files, never changing them, add
these files to "options.disable_replay"
in
.cookiecutter.json
and commit that to git.
If you want make template
to update a file that's listed in disable_replay
simply delete that file and then run make template
, it'll recreate the file
for you.
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 template_test_repo-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfc57b7cfae57a92c7edcb83bc0759befcdb15e3bd5fa34f44d4273db6d23460 |
|
MD5 | 1f8ae4444de563ad8b6bcffbdf4bf618 |
|
BLAKE2b-256 | 2d47d17d35aa18e31139dc8499f58edd52c0fd184abcef8813bc411c9c83af13 |