# sample-ds-project
[](https://img.shields.io/github/v/release/DeepakPant93/sample-ds-project)
[](https://github.com/DeepakPant93/sample-ds-project/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/DeepakPant93/sample-ds-project)
[](https://img.shields.io/github/commit-activity/m/DeepakPant93/sample-ds-project)
[](https://img.shields.io/github/license/DeepakPant93/sample-ds-project)
A Sample Project for Data Science experiments
- **Github repository**: <https://github.com/DeepakPant93/sample-ds-project/>
- **Documentation** <https://DeepakPant93.github.io/sample-ds-project/>
## 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:DeepakPant93/sample-ds-project.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/DeepakPant93/sample-ds-project/settings/secrets/actions/new).
- Create a [new release](https://github.com/DeepakPant93/sample-ds-project/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/DeepakPant93/sample-ds-project",
"name": "sample_ds_project",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Deepak Pant",
"author_email": "deepak.93p@gmail.com",
"download_url": null,
"platform": null,
"description": "# sample-ds-project\n\n[](https://img.shields.io/github/v/release/DeepakPant93/sample-ds-project)\n[](https://github.com/DeepakPant93/sample-ds-project/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/DeepakPant93/sample-ds-project)\n[](https://img.shields.io/github/commit-activity/m/DeepakPant93/sample-ds-project)\n[](https://img.shields.io/github/license/DeepakPant93/sample-ds-project)\n\nA Sample Project for Data Science experiments\n\n- **Github repository**: <https://github.com/DeepakPant93/sample-ds-project/>\n- **Documentation** <https://DeepakPant93.github.io/sample-ds-project/>\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:DeepakPant93/sample-ds-project.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/DeepakPant93/sample-ds-project/settings/secrets/actions/new).\n- Create a [new release](https://github.com/DeepakPant93/sample-ds-project/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n- For 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": "A Sample Project for Data Science experiments",
"version": "0.0.8",
"project_urls": {
"Documentation": "https://DeepakPant93.github.io/sample-ds-project/",
"Homepage": "https://github.com/DeepakPant93/sample-ds-project",
"Repository": "https://github.com/DeepakPant93/sample-ds-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5eb02de49bad7995bfa22f9b0def7d594314c226e07f564f46b8278355d6b005",
"md5": "49be0f1323a6dd357f041e8f6f7f6d63",
"sha256": "224d6fb4a6670dd32f24ec45e66a461dca377a173febb79d3b94668f6dd70d70"
},
"downloads": -1,
"filename": "sample_ds_project-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49be0f1323a6dd357f041e8f6f7f6d63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 18349,
"upload_time": "2024-12-08T15:40:21",
"upload_time_iso_8601": "2024-12-08T15:40:21.491066Z",
"url": "https://files.pythonhosted.org/packages/5e/b0/2de49bad7995bfa22f9b0def7d594314c226e07f564f46b8278355d6b005/sample_ds_project-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 15:40:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DeepakPant93",
"github_project": "sample-ds-project",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sample_ds_project"
}
JSON
