https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet

Thoughts & notes on clean pyproject.toml design
https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet

cheatsheet clean-code python

Last synced: about 1 month ago
JSON representation

Thoughts & notes on clean pyproject.toml design

• Host: GitHub
• URL: https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet
• Owner: ricardolsmendes
• License: mit
• Created: 2022-06-05T05:14:40.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-27T16:14:10.000Z (over 2 years ago)
• Last Synced: 2024-12-04T04:33:33.821Z (4 months ago)
• Topics: cheatsheet, clean-code, python
• Language: Python
• Homepage: https://betterprogramming.pub/a-pyproject-toml-developers-cheat-sheet-5782801fb3ed
• Size: 17.6 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - ricardolsmendes/pyproject-toml-cheat-sheet - Thoughts & notes on clean pyproject.toml design (Python)

README

        
# pyproject-toml-cheat-sheet

Thoughts & notes on clean `pyproject.toml` design.

[![license](https://img.shields.io/github/license/ricardolsmendes/pyproject-toml-cheat-sheet.svg)](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/blob/main/LICENSE)

[![issues](https://img.shields.io/github/issues/ricardolsmendes/pyproject-toml-cheat-sheet.svg)](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/issues)

[![continuous integration](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/actions/workflows/continuous-integration.yaml/badge.svg)](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/actions/workflows/continuous-integration.yaml)

## Get to know the concepts behind this code

[A pyproject.toml Developer’s Cheat

Sheet](https://betterprogramming.pub/a-pyproject-toml-developers-cheat-sheet-5782801fb3ed)

@ Better Programming / Medium

## Core file

- `pyproject.toml`: the package's descriptor file, in which multiple properties are set. 

  Properties declared in this file are recognized by package managers such as `pip` and

  IDEs such as _PyCharm_, which means this is a must-have for modern Python packages.

## How to contribute

Please make sure to take a moment and read the [Code of

Conduct](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/blob/main/.github/CODE_OF_CONDUCT.md).

### Report issues

Please report bugs and suggest features via the [GitHub

Issues](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/issues).

Before opening an issue, search the tracker for possible duplicates. If you find a

duplicate, please add a comment saying that you encountered the problem as well.

### Contribute code

Please make sure to read the [Contributing

Guide](https://github.com/ricardolsmendes/pyproject-toml-cheat-sheet/blob/main/.github/CONTRIBUTING.md)

before making a pull request.