| Name | cubo_harmonic JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/csaybar/cubo-harmonic |
| Summary | This is a template repository for Python projects that use Poetry for their dependency management. |
| upload_time | 2023-11-26 07:11:49 |
| maintainer | |
| docs_url | None |
| author | Cesar Aybar |
| requires_python | >=3.8,<4.0 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cubo-harmonic
[](https://img.shields.io/github/v/release/csaybar/cubo-harmonic)
[](https://github.com/csaybar/cubo-harmonic/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/csaybar/cubo-harmonic)
[](https://img.shields.io/github/commit-activity/m/csaybar/cubo-harmonic)
[](https://img.shields.io/github/license/csaybar/cubo-harmonic)
This is a template repository for Python projects that use Poetry for their dependency management.
- **Github repository**: <https://github.com/csaybar/cubo-harmonic/>
- **Documentation** <https://csaybar.github.io/cubo-harmonic/>
## Getting started with your project
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:csaybar/cubo-harmonic.git
git push -u origin main
```
Finally, install the environment and the pre-commit hooks with
```bash
make install
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
## Releasing a new version
- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/cubo-harmonic/settings/secrets/actions/new).
- Create a [new release](https://github.com/csaybar/cubo-harmonic/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
Raw data
{
"_id": null,
"home_page": "https://github.com/csaybar/cubo-harmonic",
"name": "cubo_harmonic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Cesar Aybar",
"author_email": "fcesar.aybar@uv.es",
"download_url": "https://files.pythonhosted.org/packages/fa/80/0cbc4a87de48f2ba84fe4a1dcca8271b3fbc20ace074d630d69e461202a6/cubo_harmonic-0.0.2.tar.gz",
"platform": null,
"description": "# cubo-harmonic\n\n[](https://img.shields.io/github/v/release/csaybar/cubo-harmonic)\n[](https://github.com/csaybar/cubo-harmonic/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/csaybar/cubo-harmonic)\n[](https://img.shields.io/github/commit-activity/m/csaybar/cubo-harmonic)\n[](https://img.shields.io/github/license/csaybar/cubo-harmonic)\n\nThis is a template repository for Python projects that use Poetry for their dependency management.\n\n- **Github repository**: <https://github.com/csaybar/cubo-harmonic/>\n- **Documentation** <https://csaybar.github.io/cubo-harmonic/>\n\n## Getting started with your project\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:csaybar/cubo-harmonic.git\ngit push -u origin main\n```\n\nFinally, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [Pypi](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/cubo-harmonic/settings/secrets/actions/new).\n- Create a [new release](https://github.com/csaybar/cubo-harmonic/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n",
"bugtrack_url": null,
"license": "",
"summary": "This is a template repository for Python projects that use Poetry for their dependency management.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://csaybar.github.io/cubo-harmonic/",
"Homepage": "https://github.com/csaybar/cubo-harmonic",
"Repository": "https://github.com/csaybar/cubo-harmonic"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21b1837e8d2cfdd34b1f7ab8e0083b31488d8a7713264f2c7ce730c6022e96a3",
"md5": "fc71f0184c387c5b70f89e333281b14a",
"sha256": "1223ed30fdc3f981d5939c26ee0f6ad3e84debd0e979135b7cd500ab0e4320ff"
},
"downloads": -1,
"filename": "cubo_harmonic-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc71f0184c387c5b70f89e333281b14a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 7667,
"upload_time": "2023-11-26T07:11:47",
"upload_time_iso_8601": "2023-11-26T07:11:47.309819Z",
"url": "https://files.pythonhosted.org/packages/21/b1/837e8d2cfdd34b1f7ab8e0083b31488d8a7713264f2c7ce730c6022e96a3/cubo_harmonic-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa800cbc4a87de48f2ba84fe4a1dcca8271b3fbc20ace074d630d69e461202a6",
"md5": "62e3464028e8c05320a611ac7d8278dd",
"sha256": "0f4801f9535f8a269eceb338b5f686e8e2f8a3e71bf3a4980bcc93134d8cd851"
},
"downloads": -1,
"filename": "cubo_harmonic-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "62e3464028e8c05320a611ac7d8278dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 6986,
"upload_time": "2023-11-26T07:11:49",
"upload_time_iso_8601": "2023-11-26T07:11:49.288424Z",
"url": "https://files.pythonhosted.org/packages/fa/80/0cbc4a87de48f2ba84fe4a1dcca8271b3fbc20ace074d630d69e461202a6/cubo_harmonic-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-26 07:11:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csaybar",
"github_project": "cubo-harmonic",
"github_not_found": true,
"lcname": "cubo_harmonic"
}
