https://github.com/withprecedent/project_template

template for projects using pdm, MkDocs, and GitHub Actions
https://github.com/withprecedent/project_template

Last synced: 10 months ago
JSON representation

template for projects using pdm, MkDocs, and GitHub Actions

• Host: GitHub
• URL: https://github.com/withprecedent/project_template
• Owner: WithPrecedent
• License: apache-2.0
• Created: 2023-07-12T16:46:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-07T16:48:27.000Z (almost 3 years ago)
• Last Synced: 2025-01-16T01:17:02.356Z (over 1 year ago)
• Language: Python
• Size: 1.29 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# project_template

[![PyPI Latest Release](https://img.shields.io/pypi/v/project_template.svg?style=for-the-badge&logo=PyPI)](https://pypi.org/project/project_template/)

[![Documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=for-the-badge&logo=github)](https://GITHUB_NAME.github.io/project_template)

[![CI Build](https://img.shields.io/github/actions/workflow/status/GITHUB_NAME/project_template/build.yml?branch=main&label=tests&style=for-the-badge&logo=pytest)](https://github.com/GITHUB_NAME/project_template/actions/workflows/build.yml?query=branch%3Amain)

[![Project Status](https://img.shields.io/badge/repo%20status-Active-Green?style=for-the-badge&logo=git)](https://www.repostatus.org/#active)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/project_template?style=for-the-badge&logo=python)](https://pypi.python.org/pypi/project_template/)

[![Code Coverage](https://img.shields.io/codecov/c/github/GITHUB_NAME/project_template?style=for-the-badge&logo=codecov&logoColor=white)](https://codecov.io/gh/GITHUB_NAME/project_template)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&logo=apache)](https://opensource.org/licenses/Apache-2.0)

[![PDM Managed](https://img.shields.io/badge/pdm-managed-blueviolet?style=for-the-badge)](https://pdm.fming.dev)

## What is project_template?

A template for Python projects using PDM, MkDocs, and GitHub Actions.

## Why use project_template?

## Getting started

### Installation

To install `project_template`, use `pip`:

```sh

pip install project_template

```

### Usage

## Contributing

Contributors are always welcome and should find `project_template` easy to work with. The project is highly documented so that users and developers can make `project_template` work with their projects. It is designed for Python coders at all levels. Even beginners should be able to follow the readable code and internal documentation to understand how it works. If you wish to contribute, please read the [Contribution Guide](./contributing.md) and [Code of Conduct](./code_of_conduct.md).

## Similar Projects

## Acknowledgements