https://github.com/56kyle/demo-cookiecutter-project

Example cookiecutter project generation that is used to test out new CI/CD ideas.
https://github.com/56kyle/demo-cookiecutter-project

Last synced: 7 months ago
JSON representation

Example cookiecutter project generation that is used to test out new CI/CD ideas.

• Host: GitHub
• URL: https://github.com/56kyle/demo-cookiecutter-project
• Owner: 56kyle
• License: mit
• Created: 2024-06-02T01:37:48.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T16:08:26.000Z (almost 2 years ago)
• Last Synced: 2025-01-23T05:16:19.199Z (over 1 year ago)
• Language: Python
• Size: 187 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Demo Cookiecutter Project

[![PyPI](https://img.shields.io/pypi/v/demo-cookiecutter-project.svg)][pypi status]

[![Status](https://img.shields.io/pypi/status/demo-cookiecutter-project.svg)][pypi status]

[![Python Version](https://img.shields.io/pypi/pyversions/demo-cookiecutter-project)][pypi status]

[![License](https://img.shields.io/pypi/l/demo-cookiecutter-project)][license]

[![Read the documentation at https://demo-cookiecutter-project.readthedocs.io/](https://img.shields.io/readthedocs/demo-cookiecutter-project/latest.svg?label=Read%20the%20Docs)][read the docs]

[![Tests](https://github.com/56kyle/demo-cookiecutter-project/workflows/Tests/badge.svg)][tests]

[![Codecov](https://codecov.io/gh/56kyle/demo-cookiecutter-project/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi status]: https://pypi.org/project/demo-cookiecutter-project/

[read the docs]: https://demo-cookiecutter-project.readthedocs.io/

[tests]: https://github.com/56kyle/demo-cookiecutter-project/actions?workflow=Tests

[codecov]: https://app.codecov.io/gh/56kyle/demo-cookiecutter-project

[pre-commit]: https://github.com/pre-commit/pre-commit

[black]: https://github.com/psf/black

## Features

- TODO

## Requirements

- TODO

## Installation

You can install _Demo Cookiecutter Project_ via [pip] from [PyPI]:

```console

$ pip install demo-cookiecutter-project

```

## Usage

Please see the [Command-line Reference] for details.

## Contributing

Contributions are very welcome.

To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],

_Demo Cookiecutter Project_ is free and open source software.

## Issues

If you encounter any problems,

please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz

[pypi]: https://pypi.org/

[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python

[file an issue]: https://github.com/56kyle/demo-cookiecutter-project/issues

[pip]: https://pip.pypa.io/

[license]: https://github.com/56kyle/demo-cookiecutter-project/blob/main/LICENSE

[contributor guide]: https://github.com/56kyle/demo-cookiecutter-project/blob/main/CONTRIBUTING.md

[command-line reference]: https://demo-cookiecutter-project.readthedocs.io/en/latest/usage.html