https://github.com/mcbeet/plugin-template

Template for beet plugins or python projects related to beet.
https://github.com/mcbeet/plugin-template

beet minecraft

Last synced: about 1 year ago
JSON representation

Template for beet plugins or python projects related to beet.

• Host: GitHub
• URL: https://github.com/mcbeet/plugin-template
• Owner: mcbeet
• License: mit
• Created: 2021-11-04T18:09:15.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-28T14:59:49.000Z (over 3 years ago)
• Last Synced: 2025-02-05T19:04:01.736Z (over 1 year ago)
• Topics: beet, minecraft
• Language: Python
• Homepage: https://mcbeet.github.io/plugin-template/
• Size: 345 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FIXME

[![GitHub Actions](https://github.com/FIXME/FIXME/workflows/CI/badge.svg)](https://github.com/FIXME/FIXME/actions)

[![PyPI](https://img.shields.io/pypi/v/FIXME.svg)](https://pypi.org/project/FIXME/)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/FIXME.svg)](https://pypi.org/project/FIXME/)

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

[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)

> FIXME

## Introduction

FIXME

## Installation

The package can be installed with `pip`.

```bash

$ pip install FIXME

```

## Getting started

FIXME

## Contributing

Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses [`poetry`](https://python-poetry.org).

```bash

$ poetry install

```

You can run the tests with `poetry run pytest`.

```bash

$ poetry run pytest

```

The project must type-check with [`pyright`](https://github.com/microsoft/pyright). If you're using VSCode the [`pylance`](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extension should report diagnostics automatically. You can also install the type-checker locally with `npm install` and run it from the command-line.

```bash

$ npm run watch

$ npm run check

```

The code follows the [`black`](https://github.com/psf/black) code style. Import statements are sorted with [`isort`](https://pycqa.github.io/isort/).

```bash

$ poetry run isort FIXME examples tests

$ poetry run black FIXME examples tests

$ poetry run black --check FIXME examples tests

```

---

License - [MIT](https://github.com/FIXME/FIXME/blob/main/LICENSE)