Skip to content

Commit dff3cd4

Browse files
authored
Prep for release (#93)
Update the changelog for the release and update some missing bits in the docs.
2 parents 3192524 + 2f62ea2 commit dff3cd4

File tree

4 files changed

+23
-9
lines changed

4 files changed

+23
-9
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,23 @@ Please follow these guidelines to ensure a smooth contribution process.
1414
We recommend using a virtual environment to manage dependencies. You can use `venv`, `conda`, or any other tool of your choice.
1515

1616
1. Fork/Clone the repository on GitHub
17+
1718
```bash
18-
git clone <your-fork-url>
19-
cd mediafile
19+
$ git clone <your-fork-url>
20+
$ cd mediafile
2021
```
21-
2. Install dependencies and set up the development environment
22+
23+
2. Set up your development environment
24+
25+
```bash
26+
$ python -m pip install --user pipx
27+
$ pipx install poetry poethepoet
28+
```
29+
30+
3. Install project dependencies
31+
2232
```bash
23-
pip install -e '.[dev]'
33+
$ poetry install
2434
```
2535

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

3141
```bash
32-
ruff check .
33-
ruff format .
34-
pytest .
42+
$ poe lint
43+
$ poe format
44+
$ poe test
3545
```

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Synopsis
1818
--------
1919

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

2323
.. code-block:: python
2424

docs/changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ Changelog
44
Upcoming
55
--------
66

7+
v1.0.0
8+
------
9+
710
- Dropped support for Python 3.7 and 3.8
811
- Added minimal contribution guidelines to CONTRIBUTING.md
912
- Changed project linter and formatter from ``flake8`` to ``ruff``. Reformatted
1013
the codebase with ``ruff``.
1114
- Moved changelog into its own file, ``changelog.rst``. Also added github
1215
workflow for automatic changelog reminders.
16+
- Modernized package and tests setup to use ``poetry``.
1317

1418
v0.13.0
1519
-------

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "mediafile"
3-
version = "1.0.0-rc1"
3+
version = "0.13.0"
44
description = "A simple, cross-format library for reading and writing media file metadata."
55
authors = [{ name = "Adrian Sampson", email = "[email protected]" }]
66
readme = "README.rst"

0 commit comments

Comments
 (0)