Metadata-Version: 2.1
Name: animedata
Version: 0.3
Summary: Open-source library containing database about animes/series and including a built-in utility.
Project-URL: Github, https://github.com/swarthur/animedata
Project-URL: Bug, https://github.com/swarthur/animedata/issues
Author: swarthur
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# AnimeData

## Presentation

AnimeData is a python-based project developed by swarthur.

The project's goal is to offer an open-source and easy way to get data about its favourite animes and series.

AnimeData is composed of 2 main files :

1. *animedata.py* : Python module essential to exploit and modify the JSON database.
2. *animedata_source.json* : JSON file : series database.

## Data available

Some data about an anime may be missing, especially if the anime has been added a long time ago. However, each anime should be compatible with the latest version of AnimeData.

## How to use this library

In order to make this project useful for everyone, anybody can use the provided tool to get, add or modify its animes or series, **from a compatible manager**.
> Currently, only AnimeTime is compatible with showdata.

### How does the tool works ?

The tool's input needs to be an dictionnary, specially formatted, with special keys provided in a dictionnary in the module.

Example of formatted python dictionnary :

```py
json_dict = {"anime_name":{
    "seasons_episodes":{
        "episode_number":{
            "episode_name" : "episode_name",
            "episode_duration" : 00,
            "episode_release_date" : [MM,DD,YYYY]
            }
        ...} # Others episodes
        }
    ...} # Others series 
```

### Does another JSON file is compatible ?

AnimeData uses metadata, and corruped metadata stops the tool from loading the data.

The AnimeData loading-friendly files are :

* animedata_source.json : source file of the database
* animedata_local.json : custom file, similar to the source file but containing custom data from an series manager.

The AnimeData saving-friendly files is:

* animedata_local.json : custom file used to save anime's custom data from a compatible anime manager.
