No project description provided
Project description
Chat-file
Install
- TODO | How to install this project
Usage
- TODO | How to use this project
Development
To list available commands for your convenience:
make help
Local environment setup
python3 -m venv ./venv
source ./venv/bin/activate # Linux and MacOS
venv\Scripts\activate # Windows
pip install --editable .[dev]
Run tests
make pytest # Run pytest
make style # Run lint formatting and type check
make test-all # Run all tests with tox
make auto-fix # Auto-fix possible style issues
Pre-commit hooks
To install optional pre-commit hooks; after environment set-up run:
pre-commit install
Project maintenance
Intended for project maintainers
Release
Bump my version is used to bump the semantic version of the project.
For details see:
bump-my-version bump --help
Bump my version is configured to create a new commit
and tag
it with the
new version when a version is bumped.
When a new tag is pushed to github the
publish-pypi workflow is triggered and
will build and publish the new version to PyPi. You will need to configure
Trusted Publishing for this to
work. There is also an option to trigger the workflow manually and publish to
the test instance of PyPi.
To manually publish to PyPi run:
make publish-test # Publish pkg to PyPi test instance
make publish # Publish pkg to PyPi
This will build the project and publish to PyPi with help of Twine. For authentication and additional target repositories refer to your .pypirc configuration file.
Documentation
Sphinx is used to create documentation for the project. To generate:
cd docs
make apidocs # Generates API reference documentation for the code of the project
make html # Generates HTML that can be viwed in the browser
This documentation can be hosted on eg. Read The Docs for easy accessibility.
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
File details
Details for the file chat_file-0.0.1.tar.gz
.
File metadata
- Download URL: chat_file-0.0.1.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 097361af1f45cbe213d0dfd645b44d976ba116c5ec4284f7aae9934a8f010522 |
|
MD5 | 5f1ff03d952fbbef301516f4bad25a24 |
|
BLAKE2b-256 | f095a94f749c7b73917dca0ab703aaa357aa05963b5df4d65a833a121823cfa0 |
File details
Details for the file chat_file-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: chat_file-0.0.1-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 994ee74427095ef11850452e514d33dce8fb5998dff8f5ba16286e2afbe35c62 |
|
MD5 | ce617f457efcea4c9c9530f63b62affc |
|
BLAKE2b-256 | 41d99bb2dad9380aa7fa8a0df30bc17fd7cc2b7b4a94894db0de0a27100e143f |