# clitools
[![Release](https://img.shields.io/github/v/release/fpgmaas/clitools)](https://img.shields.io/github/v/release/fpgmaas/clitools)
[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/clitools/Main/main)](https://github.com/fpgmaas/clitools/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/fpgmaas/clitools/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/clitools)
[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/clitools)](https://img.shields.io/github/commit-activity/m/fpgmaas/clitools)
[![License](https://img.shields.io/github/license/fpgmaas/clitools)](https://img.shields.io/github/license/fpgmaas/clitools)
Test project
- **Github repository**: <https://github.com/fpgmaas/clitools/>
- **Documentation** <https://fpgmaas.github.io/clitools/>
## 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/clitools.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/clitools/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see
[here](https://fpgmaas.github.io/clitools/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/clitools/features/codecov/).
## Releasing a new version
---
Repository initiated with [fpgmaas/clitools](https://github.com/fpgmaas/clitools).
Raw data
{
"_id": null,
"home_page": "https://github.com/fpgmaas/clitools",
"name": "keeps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<=3.11",
"maintainer_email": "",
"keywords": "",
"author": "Florian Maas",
"author_email": "ffpgmaas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/41/34/51ca2448c08b2bbe374a12bcc8641b21a16477ac3b80ec239d4d0a067bb7/keeps-0.0.1.tar.gz",
"platform": null,
"description": "# clitools\n\n[![Release](https://img.shields.io/github/v/release/fpgmaas/clitools)](https://img.shields.io/github/v/release/fpgmaas/clitools)\n[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/clitools/Main/main)](https://github.com/fpgmaas/clitools/actions/workflows/main.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/fpgmaas/clitools/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/clitools)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/clitools)](https://img.shields.io/github/commit-activity/m/fpgmaas/clitools)\n[![License](https://img.shields.io/github/license/fpgmaas/clitools)](https://img.shields.io/github/license/fpgmaas/clitools)\n\nTest project\n\n- **Github repository**: <https://github.com/fpgmaas/clitools/>\n- **Documentation** <https://fpgmaas.github.io/clitools/>\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/clitools.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! The CI/CD\npipeline will be triggered when you open a pull request, merge to main,\nor when you create a new release.\n\nTo finalize the set-up for publishing to PyPi or Artifactory, see\n[here](https://fpgmaas.github.io/clitools/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see\n[here](https://fpgmaas.github.io/clitools/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/clitools/features/codecov/).\n\n## Releasing a new version\n\n\n\n---\n\nRepository initiated with [fpgmaas/clitools](https://github.com/fpgmaas/clitools).",
"bugtrack_url": null,
"license": "",
"summary": "Test project",
"version": "0.0.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8d54c6ea6f885b3d3d6d08e72a5e68ba",
"sha256": "e902c0444e08d1983ea4a5d8fa61a4553b06bf82705f52833c650a8cc5da0596"
},
"downloads": -1,
"filename": "keeps-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d54c6ea6f885b3d3d6d08e72a5e68ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<=3.11",
"size": 11328,
"upload_time": "2022-12-11T16:56:16",
"upload_time_iso_8601": "2022-12-11T16:56:16.836972Z",
"url": "https://files.pythonhosted.org/packages/58/0e/717f9a526be6d96e6100c1cbbec5941f73f9124b6d92300066451e697e53/keeps-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "09eeab59863f8b6af19516be75f82509",
"sha256": "1673e0caf39d71ed1a0c03afb0a7279288512ecf767f69a68e44f43d3f6c9db7"
},
"downloads": -1,
"filename": "keeps-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "09eeab59863f8b6af19516be75f82509",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<=3.11",
"size": 8579,
"upload_time": "2022-12-11T16:56:18",
"upload_time_iso_8601": "2022-12-11T16:56:18.183540Z",
"url": "https://files.pythonhosted.org/packages/41/34/51ca2448c08b2bbe374a12bcc8641b21a16477ac3b80ec239d4d0a067bb7/keeps-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-11 16:56:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fpgmaas",
"github_project": "clitools",
"lcname": "keeps"
}