Metadata-Version: 2.1
Name: yugioh-scraper
Version: 0.1.0
Summary: Yu-Gi-Oh! Scraper is a project that crawls websites and APIs and extracts Yu-Gi-Oh! related data from their pages.
Author-email: Albert Marrero <contact@albertmarrero.me>
Maintainer-email: Albert Marrero <contact@albertmarrero.me>
License: 
        The MIT License (MIT)
        
        Copyright (c) 2022 Albert Marrero
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/albert-marrero/Yu-Gi-Oh-Scrapers
Project-URL: Bug Reports, https://github.com/albert-marrero/Yu-Gi-Oh-Scraper/issues
Project-URL: Source, https://github.com/albert-marrero/Yu-Gi-Oh-Scraper
Keywords: scraper,scrapy,yugioh,data,datasets
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: Scrapy
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

# Yu-Gi-Oh! Scraper

<p align="center">
    <a href="https://docs.python.org/release/3.11.0/"><img src="https://img.shields.io/github/pipenv/locked/python-version/albert-marrero/Yu-Gi-Oh-Scraper"></a>
    <a href="https://github.com/albert-marrero/Yu-Gi-Oh-Scraper/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/albert-marrero/Yu-Gi-Oh-Scraper"></a>
</p>

Yu-Gi-Oh! Scraper is a project that crawls websites and APIs and extracts Yu-Gi-Oh! related data from their pages.

## Sources

* [Yu-Gi-Oh! Card Database](https://www.db.yugioh-card.com/yugiohdb/?request_locale=en) (`db_yugioghcard`)

### Flowcharts

These flowcharts represent a workflow of each source of the project.

#### Yu-Gi-Oh! Card Database

```mermaid
graph LR
    Products(Get All Products)-->RemoveProductDuplicates[[Remove Duplicate Product By Name]]
    RemoveProductDuplicates-->ProductCard(Get All Cards)
    ProductCard-->RemoveCardDuplicates[[Remove Duplicate Cards By Name]]
    RemoveCardDuplicates-->Cards(Get Card Details)
```

### Entity Relationship Diagrams

These entity–relationship model (or ER model) describes interrelated things of interest of each source of the project.

#### Yu-Gi-Oh! Card Database

```mermaid
erDiagram
    PRODUCTS {
        string product_type
        string product_name
        string data_type
    }
    PRODUCTS ||--|{ CARDS : contains
    CARDS {
        string card_name
        string card_rarity
        list card_details
        string product_name
        string product_release_date
        string data_type
    }
```

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Requirements for the software and other tools to build, test and push

<p>
    <a href="https://black.readthedocs.io/en/stable/"><img src="https://img.shields.io/github/pipenv/locked/dependency-version/albert-marrero/Yu-Gi-Oh-Scraper/dev/black"></a>
    <a href="https://docs.scrapy.org/en/2.7/"><img src="https://img.shields.io/github/pipenv/locked/dependency-version/albert-marrero/Yu-Gi-Oh-Scraper/scrapy"></a>
</p>

### Installing

I strongly recommend that you install this project in a dedicated virtual environment to avoid conflicting with your system packages.

See [Virtual Environments and Packages](https://docs.python.org/3/tutorial/venv.html#tut-venv) on how to create and use your virtual environment.

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the requirements of this project.

```bash
python -m pip install -r requirements.txt
```

## Built With

* [Black](https://black.readthedocs.io/en/stable/) - An uncompromising Python code formatter
* [Scrapy](https://docs.scrapy.org/en/2.7/) - A fast high-level web crawling and web scraping framework

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
of conduct, and the process for submitting pull requests to us.

## Versioning

We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this
repository](https://github.com/albert-marrero/Yu-Gi-Oh-Scraper/tags).

## Authors

  - [**Albert Marrero**](https://github.com/albert-marrero) - *Provided Initial Code*

See also the list of
[contributors](https://github.com/albert-marrero/contributors)
who participated in this project.

## Support

If you enjoy this repository, please [star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars) this repository. By starring a repository, it shows appreciation to the repository maintainer for their work. Many of GitHub's repository rankings depend on the number of stars a repository has.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
