Metadata-Version: 2.1
Name: animec
Version: 0.1.0
Summary: An unofficial API to get data about anime characters, anime news, anime info and more.
Home-page: https://github.com/DriftAsimov/animec
Author: DriftAsimov
Author-email: driftasimov@gmail.com
License: MIT
Description: <p align = "center"><img width="248" height="248" src="https://i.imgur.com/IyUybvv.png"></p>
        <p align = "center"><a href = "https://discord.gg/x3qAZV3" target = "_blank"><img src = "https://discord.com/api/guilds/759396489373155338/embed.png"></a></p>
        
        # Animec
        
        An unofficial API to get data about anime characters, anime news, anime info and more.
        The API scrapes [myanimelist](https://myanimelist.net/) to parse requested data.
        
        If you wish to see a feature, please raise an [issue](https://github.com/DriftAsimov/animec). We will surely work on it.
        You can also join our [Discord](https://discord.gg/x3qAZV3) to get regular updates about the API.
        
        ## Installation and Usage
        
        To install the library:
        ```python
        pip install animec
        ```
        
        To import the library:
        ```python
        import animec
        # OR
        from animec import *
        ```
        
        ## Examples
        
        ### Extracting an anime character's data
        
        ```python
        result = charsearch("okabe rintarou")
        
        print(result.title, result.url, result.image_url, sep="\n")
        
        '''
        Output: (As retrieved from myanimelist)
        Rintarou Okabe (岡部 倫太郎)
        https://myanimelist.net/character/35252/Rintarou_Okabe
        https://cdn.myanimelist.net/images/characters/6/122643.jpg
        '''
        ```
        
        ### Requesting anime news
        
        ```python
        news = aninews(3)   #default value is 2
        
        print(news.titles)  #returns news titles
        print(news.links)   #returns news links
        print(news.descripion)   #returns news description
        print(news.images)  #returns news images
        
        ```
        
        ### Getting anime urls and recommendations
        
        ```python
        anime = anime("dr stone")
        recommendations = anime.recommend()
        
        print(anime.url)
        print(anime.name)
        print(anime.description)    #check the documendation for a list of all supported attributes
        print(recommendations)  #returns a list of anime recommendations
        ```
        
        ## API Documentation
        
        List of properties and methods currently supported by animec.
        Official documentation coming soon!
        
        ```
        charsearch()
        ----- .title
        ----- .url
        ----- .image_url
        
        aninews()
        ----- .titles
        ----- .links
        ----- .description
        ----- .images
        
        anime()
        ----- .url
        ----- .name
        ----- .description
        ----- .poster
        ----- .title_english
        ----- .title_jp
        ----- .alt_titles
        ----- .opening_themes
        ----- .ending_themes
        ----- .episodes
        ----- .aired
        ----- .broadcast
        ----- .rating
        ----- .ranked
        ----- .popularity
        ----- .favorites
        
        ----- .recommend()
        ```
        
        ## Credits
        
        ```
        Author: DriftAsimov
        GitHub: https://github.com/DriftAsimov
        Language Used: Python
        ```
        
        ## Contact Us
        ```
        Mail: driftasimov@gmail.com
        Discord: Drift Asimov#3338 | https://discord.gg/x3qAZV3
        ```
        
        > Note: I do not own myanimelist. I have just used it to extract the data.
Keywords: animecharacter anime api character myanimelist news animenews animeinfo
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Education :: Testing
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
