https://github.com/hexlet-boilerplates/python-package

An example of typical python package
https://github.com/hexlet-boilerplates/python-package

example-project package python python3

Last synced: about 2 months ago
JSON representation

An example of typical python package

• Host: GitHub
• URL: https://github.com/hexlet-boilerplates/python-package
• Owner: hexlet-boilerplates
• Created: 2016-03-06T17:06:56.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2025-04-08T15:47:02.000Z (3 months ago)
• Last Synced: 2025-04-08T16:32:35.433Z (3 months ago)
• Topics: example-project, package, python, python3
• Language: Python
• Homepage:
• Size: 101 KB
• Stars: 140
• Watchers: 16
• Forks: 200
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# python-package

[![Github Actions Status](https://github.com/hexlet-boilerplates/python-package/workflows/Python%20CI/badge.svg)](https://github.com/hexlet-boilerplates/python-package/actions)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=hexlet-boilerplates_python-package&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=hexlet-boilerplates_python-package)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=hexlet-boilerplates_python-package&metric=coverage)](https://sonarcloud.io/summary/new_code?id=hexlet-boilerplates_python-package)

### Links

This project was built using these tools:

| Tool                                                                   | Description                                             |

|------------------------------------------------------------------------|---------------------------------------------------------|

| [uv](https://docs.astral.sh/uv/)                                       | "An extremely fast Python package and project manager, written in Rust" |

| [Pytest](https://pytest.org)                                           | "A mature full-featured Python testing tool"            |

| [ruff](https://docs.astral.sh/ruff/)                                   | "An extremely fast Python linter and code formatter, written in Rust" |

---

### Setup

```bash

make install

```

### Examples

```bash

uv run hexlet-python-package 5

2.5

```

### Run tests

```bash

make test

```

[![Hexlet Ltd. logo](https://raw.githubusercontent.com/Hexlet/assets/master/images/hexlet_logo128.png)](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=python-package)

This repository is created and maintained by the team and the community of Hexlet, an educational project. [Read more about Hexlet](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=python-package).

See most active contributors on [hexlet-friends](https://friends.hexlet.io/).