Metadata-Version: 2.1
Name: pymemapi
Version: 0.1.0rc0
Summary: Memrise API
Home-page: https://github.com/josephquang97/memrise
Author: Joseph Quang
Author-email: tquangsdh20@fsob.win
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: bs4 (>=0.0,<0.1)
Requires-Dist: googletrans (==4.0.0rc1)
Requires-Dist: memrise (>=1.3.0,<2.0.0)
Requires-Dist: pandas (>=1.3.5,<2.0.0)
Requires-Dist: pydantic (>=1.9.0,<2.0.0)
Requires-Dist: pyttsx3 (>=2.90,<3.0)
Requires-Dist: text2ipa (>=1.3,<2.0)
Project-URL: Repository, https://github.com/josephquang97/memrise
Description-Content-Type: text/markdown

# Memrise API

<p align="center"><img src="https://github.com/josephquang97/pymemapi/actions/workflows/test.yml/badge.svg"><a href="https://codecov.io/github/josephquang97/memrise/commit/8abed823b295beb7ecda8b564df2b81905fb81ad"><img src = "https://codecov.io/gh/josephquang97/pymemapi/branch/main/graphs/badge.svg?branch=main"></a></p>

## Installation

```
python -m pip install PyMemAPI
```

## Major Features

- API Memrise with some actions such as create new level, add bulk, rename level, ...
- Automaticially generate the audio and upload to Memrise
- Automaticially translate, get the International Phonetics Alphabet from database and sync with Memrise

## Documentations

The library have 3 main classes `Memrise`, `Course` and `SQLite`.

### Memrise

Memrise object will control your connection to Memrise. It's required your username and password to take permissions. And then it'll grant the necessary permission for the further process.

```python
class Memrise:
    username: str = field(init=False)
    password: str = field(init=False)
    session: requests.Session = requests.Session()
	
	def login(self, username, password) -> bool: ...
	def courses(self) -> List[Course]: ...
	def get(self, path: str, params: Optional[Dict[str, Any]] = None): ...
	def post(
        self,
        path: str,
        payload: Dict[str, Any],
        headers: Dict[str, str],
        files: Optional[Dict[str, Tuple[str, bytes, str]]] = None,
    ) -> requests.Response: ...

    def select_course(self) -> Course: ...
```

### Course


### SQLite



