# elevenfiftynine-python-core-lib
[](https://img.shields.io/github/v/release/fpgmaas/elevenfiftynine-python-core-lib)
[](https://github.com/fpgmaas/elevenfiftynine-python-core-lib/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/fpgmaas/elevenfiftynine-python-core-lib)
[](https://img.shields.io/github/commit-activity/m/fpgmaas/elevenfiftynine-python-core-lib)
[](https://img.shields.io/github/license/fpgmaas/elevenfiftynine-python-core-lib)
This is a template repository for Python projects that use Poetry for their dependency management.
- **Github repository**: <https://github.com/fpgmaas/elevenfiftynine-python-core-lib/>
- **Documentation** <https://fpgmaas.github.io/elevenfiftynine-python-core-lib/>
## 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:fpgmaas/elevenfiftynine-python-core-lib.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/fpgmaas/elevenfiftynine-python-core-lib/settings/secrets/actions/new).
- Create a [new release](https://github.com/fpgmaas/elevenfiftynine-python-core-lib/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/fpgmaas/elevenfiftynine-python-core-lib",
"name": "elevenfiftynine_python_core_lib",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Florian Maas",
"author_email": "ffpgmaas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/b6/99bbad6a6491d0b5cce711110da6c950bc170c9d941fb0451fb90728a021/elevenfiftynine_python_core_lib-0.1.0.tar.gz",
"platform": null,
"description": "# elevenfiftynine-python-core-lib\n\n[](https://img.shields.io/github/v/release/fpgmaas/elevenfiftynine-python-core-lib)\n[](https://github.com/fpgmaas/elevenfiftynine-python-core-lib/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/fpgmaas/elevenfiftynine-python-core-lib)\n[](https://img.shields.io/github/commit-activity/m/fpgmaas/elevenfiftynine-python-core-lib)\n[](https://img.shields.io/github/license/fpgmaas/elevenfiftynine-python-core-lib)\n\nThis is a template repository for Python projects that use Poetry for their dependency management.\n\n- **Github repository**: <https://github.com/fpgmaas/elevenfiftynine-python-core-lib/>\n- **Documentation** <https://fpgmaas.github.io/elevenfiftynine-python-core-lib/>\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:fpgmaas/elevenfiftynine-python-core-lib.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/fpgmaas/elevenfiftynine-python-core-lib/settings/secrets/actions/new).\n- Create a [new release](https://github.com/fpgmaas/elevenfiftynine-python-core-lib/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": null,
"summary": "This is a template repository for Python projects that use Poetry for their dependency management.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://fpgmaas.github.io/elevenfiftynine-python-core-lib/",
"Homepage": "https://github.com/fpgmaas/elevenfiftynine-python-core-lib",
"Repository": "https://github.com/fpgmaas/elevenfiftynine-python-core-lib"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cc84c750e4328fb3d3dd27f63b77d8d88eca891ab7af23b301dc29c4c5e1210",
"md5": "26004821b11860b7d7e53dde2cc790a0",
"sha256": "e896be78eda35dab7a6b68fabdabc4171f58755e11c57b31de134cfcde6b6b83"
},
"downloads": -1,
"filename": "elevenfiftynine_python_core_lib-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26004821b11860b7d7e53dde2cc790a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 2828,
"upload_time": "2024-04-19T19:26:35",
"upload_time_iso_8601": "2024-04-19T19:26:35.420494Z",
"url": "https://files.pythonhosted.org/packages/5c/c8/4c750e4328fb3d3dd27f63b77d8d88eca891ab7af23b301dc29c4c5e1210/elevenfiftynine_python_core_lib-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cab699bbad6a6491d0b5cce711110da6c950bc170c9d941fb0451fb90728a021",
"md5": "00bcd3edaa44cb7fc2173f63439edc6c",
"sha256": "413f07e08026255b45cb456c7a223eb8e9ee87d47a08e016e0134e6cd0222bd4"
},
"downloads": -1,
"filename": "elevenfiftynine_python_core_lib-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "00bcd3edaa44cb7fc2173f63439edc6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 2456,
"upload_time": "2024-04-19T19:26:37",
"upload_time_iso_8601": "2024-04-19T19:26:37.197808Z",
"url": "https://files.pythonhosted.org/packages/ca/b6/99bbad6a6491d0b5cce711110da6c950bc170c9d941fb0451fb90728a021/elevenfiftynine_python_core_lib-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 19:26:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fpgmaas",
"github_project": "elevenfiftynine-python-core-lib",
"github_not_found": true,
"lcname": "elevenfiftynine_python_core_lib"
}
JSON
