https://github.com/fpgmaas/example-project

https://github.com/fpgmaas/example-project

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fpgmaas/example-project
• Owner: fpgmaas
• License: mit
• Created: 2022-09-26T11:34:23.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-15T20:05:00.000Z (over 3 years ago)
• Last Synced: 2025-04-05T00:25:47.267Z (over 1 year ago)
• Language: Makefile
• Size: 37.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
# example-project

[![Release](https://img.shields.io/github/v/release/fpgmaas/example-project)](https://img.shields.io/github/v/release/fpgmaas/example-project)

[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/example-project/merge-to-main)](https://img.shields.io/github/workflow/status/fpgmaas/example-project/merge-to-main)

[![codecov](https://codecov.io/gh/fpgmaas/example-project/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/example-project)

[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/example-project)](https://img.shields.io/github/commit-activity/m/fpgmaas/example-project)

[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://fpgmaas.github.io/example-project/)

[![Code style with black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports with isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/)

[![License](https://img.shields.io/github/license/fpgmaas/example-project)](https://img.shields.io/github/license/fpgmaas/example-project)

This is a template repository for Python projects that use Poetry for their dependency management.

- **Github repository**: 

- **Documentation** 

## 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/example-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/fpgmaas/example-project/settings/secrets/actions/new).

- Create a [new release](https://github.com/fpgmaas/example-project/releases/new) on Github. 

Create a new tag in the form ``*.*.*``.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/releasing.html).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).