A todo client with CLI and REPL interfaces.
Project description
Example Package
This is a simple example package. You can use GitHub-flavored Markdown to write your content.
This package is designed to provide [describe functionality]. It's perfect for [describe target audience] and can help you to [describe benefits].
Table of Contents
Installation
To install this package, you can clone the repository using the following command:
git clone https://github.com/rmkane/packaging_tutorial.git
To install from PyPI:
pip install todo-client
To install locally:
make install # Install
.venv/bin/todo # Run
Usage
Here are some examples of how to use this package:
from todo_client.example import add_one
print(add_one(1)) # 2
Setup
Configure the TestPyPI repository and token:
poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi <your-token>
On macOS, the file is located at ~/Library/Application\ Support/pypoetry/config.toml
Source: using python-poetry to publish to test.pypi.org
Build Instructions
This project uses a Makefile for managing build tasks. Here are some of the commands you can use:
make all
: Default target, sets up the virtual environment and runs the build.make create_venv
: Creates a virtual environment and installs Poetry.make activate
: Activates the virtual environment.make install_deps
: Installs project dependencies using Poetry.make build
: Sets up the virtual environment, installs dependencies, and runs the build.make publish
: Builds the project and uploads it to TestPyPI.make test
: Runs tests using pytest.make format
: Formats code using black.make apidoc
: Generates Sphinx.rst
files.make docs
: Builds Sphinx documentation.make clean
: Removes build artifacts.make clean_all
: Removes the virtual environment, build artifacts, and__pycache__
directories.make help
: Shows available make targets.
Commands
-
Create Virtual Environment and Install Poetry:
make create_venv
-
Activate Virtual Environment:
make activate
-
Install Project Dependencies:
make install_deps
-
Build the Project:
make build
-
Publish to TestPyPI:
make publish
-
Run Tests:
make test
-
Format Code:
make format
-
Generate Sphinx .rst Files:
make apidoc
-
Build Sphinx Documentation:
make docs
-
Clean Project:
make clean
-
Clean All Generated Files:
make clean_all
-
Show Available Make Targets:
make help
Remember to run source .venv/bin/activate
to activate the virtual environment before running the build commands.
Changelog
See CHANGELOG.md for details.
Updating the Changelog
To update the changelog, please use the following format:
## [Unreleased]
### Added
- New features that have been added since the last release
### Changed
- Changes to existing functionality
### Deprecated
- Features that will be removed in upcoming releases
### Removed
- Features that have been removed
### Fixed
- Any bug fixes
### Security
- Any security enhancements
Contributing
We welcome contributions to this project! To contribute:
- Fork this repository
- Create your feature branch (
git checkout -b feature/yourFeature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin feature/yourFeature
) - Create a new Pull Request
License
This project is licensed under the MIT license - see the LICENSE file for details.
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 todo_client-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e333e47688e63f98ef7cd7c60b58ab6ee29a55f46da40102094c72e2db633c8 |
|
MD5 | a5fdca01afeb3aae42a9e4c40d3f92d8 |
|
BLAKE2b-256 | c0bda909b3e9033afaf1cff45b3e568a593b483e9de47b24f9be16672bd2ca7c |