Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,23 @@ Please follow these guidelines to ensure a smooth contribution process.
We recommend using a virtual environment to manage dependencies. You can use `venv`, `conda`, or any other tool of your choice.

1. Fork/Clone the repository on GitHub

```bash
git clone <your-fork-url>
cd mediafile
$ git clone <your-fork-url>
$ cd mediafile
```
2. Install dependencies and set up the development environment

2. Set up your development environment

```bash
$ python -m pip install --user pipx
$ pipx install poetry poethepoet
```

3. Install project dependencies

```bash
pip install -e '.[dev]'
$ poetry install
```

## Before submitting a Pull Request
Expand All @@ -29,7 +39,7 @@ Verify that your code adheres to the project standards and conventions. Run
ruff and pytest to ensure your code is properly formatted and all tests pass.

```bash
ruff check .
ruff format .
pytest .
$ poe lint
$ poe format
$ poe test
```
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Synopsis
--------

MediaFile is available `on PyPI`_. Install it by typing ``pip install
mediafile``. It works on Python 3.7 or later. Then:
mediafile``. It works on Python 3.9 or later. Then:

.. code-block:: python

Expand Down
4 changes: 4 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ Changelog
Upcoming
--------

v1.0.0
------

- Dropped support for Python 3.7 and 3.8
- Added minimal contribution guidelines to CONTRIBUTING.md
- Changed project linter and formatter from ``flake8`` to ``ruff``. Reformatted
the codebase with ``ruff``.
- Moved changelog into its own file, ``changelog.rst``. Also added github
workflow for automatic changelog reminders.
- Modernized package and tests setup to use ``poetry``.

v0.13.0
-------
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "mediafile"
version = "1.0.0-rc1"
version = "0.13.0"
description = "A simple, cross-format library for reading and writing media file metadata."
authors = [{ name = "Adrian Sampson", email = "[email protected]" }]
readme = "README.rst"
Expand Down