[](https://discord.gg/qUtxnK2NMf)
# Python Package Template
A easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more
## Installation
You can install the package using pip
```bash
pip install -e .
```
# Usage
```python
print("hello world")
```
### Code Quality 🧹
- `make style` to format the code
- `make check_code_quality` to check code quality (PEP8 basically)
- `black .`
- `ruff . --fix`
### Tests 🧪
[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.
### Publish on PyPi 🚀
**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
```
poetry build
poetry publish
```
### CI/CD 🤖
We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.
On any pull request, we will check the code quality and tests.
When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier.
The **correct steps** to create a new realease are the following:
- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI.
- create a new release from GitHub UI
The CI will run when you create the new release.
# Docs
We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.
# License
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/kyegomez/ViTAR",
"name": "vitar",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "artificial intelligence, deep learning, optimizers, Prompt Engineering",
"author": "Kye Gomez",
"author_email": "kye@apac.ai",
"download_url": "https://files.pythonhosted.org/packages/52/6e/936e57cd0556244339f88b70b4d981d3dd8067d7d51c4ae609a83eb47542/vitar-0.0.1.tar.gz",
"platform": null,
"description": "[](https://discord.gg/qUtxnK2NMf)\n\n# Python Package Template\nA easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more\n\n\n## Installation\n\nYou can install the package using pip\n\n```bash\npip install -e .\n```\n\n# Usage\n```python\nprint(\"hello world\")\n\n```\n\n\n\n### Code Quality \ud83e\uddf9\n\n- `make style` to format the code\n- `make check_code_quality` to check code quality (PEP8 basically)\n- `black .`\n- `ruff . --fix`\n\n### Tests \ud83e\uddea\n\n[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.\n\n### Publish on PyPi \ud83d\ude80\n\n**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.\n\n```\npoetry build\npoetry publish\n```\n\n### CI/CD \ud83e\udd16\n\nWe use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.\n\nOn any pull request, we will check the code quality and tests.\n\nWhen a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier. \n\nThe **correct steps** to create a new realease are the following:\n- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.\n- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI.\n- create a new release from GitHub UI\n\nThe CI will run when you create the new release.\n\n# Docs\nWe use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.\n\n\n\n# License\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Paper - Pytorch",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/kyegomez/ViTAR",
"Homepage": "https://github.com/kyegomez/ViTAR",
"Repository": "https://github.com/kyegomez/ViTAR"
},
"split_keywords": [
"artificial intelligence",
" deep learning",
" optimizers",
" prompt engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c890304c4045dcb8eb492e1f05163399e1b3c7019c8c0ae9415c3587f151303c",
"md5": "f136e4ce101766cbb0592f55c330a211",
"sha256": "368b9cf2f84094d9da7819032a2c3099643e251bf46c344da9f8b57216d83c08"
},
"downloads": -1,
"filename": "vitar-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f136e4ce101766cbb0592f55c330a211",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 5382,
"upload_time": "2024-08-28T22:38:09",
"upload_time_iso_8601": "2024-08-28T22:38:09.396449Z",
"url": "https://files.pythonhosted.org/packages/c8/90/304c4045dcb8eb492e1f05163399e1b3c7019c8c0ae9415c3587f151303c/vitar-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "526e936e57cd0556244339f88b70b4d981d3dd8067d7d51c4ae609a83eb47542",
"md5": "bf8d5682ee9e3c03b40b9f88b684e756",
"sha256": "3bac7cd73c5f1b0a9b9fce8b803e8bb1eec529ef3c638ec1e2dc491aa194726d"
},
"downloads": -1,
"filename": "vitar-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "bf8d5682ee9e3c03b40b9f88b684e756",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4948,
"upload_time": "2024-08-28T22:38:10",
"upload_time_iso_8601": "2024-08-28T22:38:10.889358Z",
"url": "https://files.pythonhosted.org/packages/52/6e/936e57cd0556244339f88b70b4d981d3dd8067d7d51c4ae609a83eb47542/vitar-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 22:38:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kyegomez",
"github_project": "ViTAR",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "torch",
"specs": []
},
{
"name": "zetascale",
"specs": []
},
{
"name": "swarms",
"specs": []
}
],
"lcname": "vitar"
}
JSON
