https://github.com/ravencentric/myne

https://github.com/ravencentric/myne

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ravencentric/myne
• Owner: Ravencentric
• License: apache-2.0
• Created: 2025-05-02T18:45:47.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-12-01T10:55:10.000Z (8 months ago)
• Last Synced: 2025-12-03T21:20:51.093Z (8 months ago)
• Language: Rust
• Homepage: https://ravencentric.cc/myne/
• Size: 247 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# myne

[![Tests](https://img.shields.io/github/actions/workflow/status/Ravencentric/myne/tests.yml?label=tests)](https://github.com/Ravencentric/myne/actions/workflows/tests.yml)

[![Build](https://img.shields.io/github/actions/workflow/status/Ravencentric/myne/release.yml?label=build)](https://github.com/Ravencentric/myne/actions/workflows/release.yml)

![PyPI - Types](https://img.shields.io/pypi/types/myne)

![License](https://img.shields.io/pypi/l/myne?color=success)

[![PyPI - Latest Version](https://img.shields.io/pypi/v/myne?color=blue)](https://pypi.org/project/myne)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/myne)

![PyPI - Implementation](https://img.shields.io/pypi/implementation/myne)

`myne` is a parser for manga and light novel filenames, providing the `Book` class for extracting and representing metadata such as title, volume, chapter, edition, and more.

## Usage

```python

from myne import Book

book = Book.parse("Ascendance of a Bookworm - v07 (2021) (Digital) (Kinoworm).cbz")

assert book.title == "Ascendance of a Bookworm"

assert book.volume == "7"

assert book.year == 2021

assert book.digital is True

assert book.group == "Kinoworm"

```

Checkout the complete documentation [here](https://ravencentric.cc/myne/).

## Installation

`myne` is available on [PyPI](https://pypi.org/project/myne/), so you can simply use pip to install it.

```console

pip install myne

```

## Building from source

Building from source requires the [Rust toolchain](https://rustup.rs/) and [Python 3.9+](https://www.python.org/downloads/).

- With [`uv`](https://docs.astral.sh/uv/):

  ```console

  git clone https://github.com/Ravencentric/myne

  cd myne

  uv build

  ```

- With [`pypa/build`](https://github.com/pypa/build):

  ```console

  git clone https://github.com/Ravencentric/myne

  cd myne

  python -m build

  ```

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/Ravencentric/myne/blob/main/LICENSE-APACHE) or )

- MIT license ([LICENSE-MIT](https://github.com/Ravencentric/myne/blob/main/LICENSE-MIT) or )

at your option.

## Contributing

Contributions are welcome! Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.