[](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/Infini-attention",
"name": "infini-torch",
"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/d0/5a/9efd969fad199ef38fa8688c80c949fa223ce4a217d970abc306ad5d27e6/infini_torch-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": "infini - Pytorch",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/kyegomez/Infini-attention",
"Homepage": "https://github.com/kyegomez/Infini-attention",
"Repository": "https://github.com/kyegomez/Infini-attention"
},
"split_keywords": [
"artificial intelligence",
" deep learning",
" optimizers",
" prompt engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e0b57700a342495080afb8f1109f6a17289edcc3b075c60d3926d10be444939f",
"md5": "55a6dfc0c03d0636a95a9461c0100a16",
"sha256": "b10210e4cac247f3eb4fbdff5c5f6047a6b94df261541f4d918d7c9be1cd7bd6"
},
"downloads": -1,
"filename": "infini_torch-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55a6dfc0c03d0636a95a9461c0100a16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 3930,
"upload_time": "2024-04-15T00:39:39",
"upload_time_iso_8601": "2024-04-15T00:39:39.733722Z",
"url": "https://files.pythonhosted.org/packages/e0/b5/7700a342495080afb8f1109f6a17289edcc3b075c60d3926d10be444939f/infini_torch-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d05a9efd969fad199ef38fa8688c80c949fa223ce4a217d970abc306ad5d27e6",
"md5": "41d886e2435eb1e3e71121e90ca0b4cc",
"sha256": "89fb16ccb788334cd5a130c0616f2e07d02349d9610be8d01fc3103082c31893"
},
"downloads": -1,
"filename": "infini_torch-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "41d886e2435eb1e3e71121e90ca0b4cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4052,
"upload_time": "2024-04-15T00:39:41",
"upload_time_iso_8601": "2024-04-15T00:39:41.732611Z",
"url": "https://files.pythonhosted.org/packages/d0/5a/9efd969fad199ef38fa8688c80c949fa223ce4a217d970abc306ad5d27e6/infini_torch-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 00:39:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kyegomez",
"github_project": "Infini-attention",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "torch",
"specs": []
},
{
"name": "zetascale",
"specs": []
},
{
"name": "swarms",
"specs": []
}
],
"lcname": "infini-torch"
}
JSON
