Metadata-Version: 2.1
Name: apadata
Version: 0.3.0
Summary: Apadata is apadua's data science library
Home-page: https://github.com/apadua-org/apadata
License: MIT
Author: Nik Atlas
Author-email: nikatlas@gmail.com
Requires-Python: >=3.8.1,<3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: babel (>=2.12.1,<3.0.0)
Requires-Dist: cachetools (>=5.3.1,<6.0.0)
Requires-Dist: deep-translator (>=1.11.4,<2.0.0)
Requires-Dist: django (>=3.0.0,<5.0.0)
Requires-Dist: django-postgres-extra (>=2.0.8,<3.0.0)
Requires-Dist: django-redis (>=5.3.0,<6.0.0)
Requires-Dist: django-rq (>=2.8.0,<3.0.0)
Requires-Dist: elasticsearch (>=8.0.0,<9.0.0)
Requires-Dist: geostring (>=1.0.9,<2.0.0)
Requires-Dist: goslate (>=1.5.4,<2.0.0)
Requires-Dist: inflect (>=7.0.0,<8.0.0)
Requires-Dist: langdetect (>=1.0.8,<2.0.0)
Requires-Dist: lxml (>=4.9.3,<5.0.0)
Requires-Dist: openai (>=0.27.9,<0.28.0)
Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
Requires-Dist: pinecone-client (>=2.2.0,<3.0.0)
Requires-Dist: pyspellchecker (>=0.7.2,<0.8.0)
Requires-Dist: pytest-snapshot (>=0.9.0,<0.10.0)
Requires-Dist: redis (>3.0.0)
Requires-Dist: rq (>=1.4.3)
Requires-Dist: sentence-transformers (>=2.2.2,<3.0.0)
Requires-Dist: sentry-sdk (>1.0.0)
Requires-Dist: snapshot (>=0.1.2,<0.2.0)
Requires-Dist: spacy (>=3.6.0,<4.0.0)
Requires-Dist: spacy-transformers (>=1.2.0,<2.0.0)
Requires-Dist: structlog (>=23.1.0,<24.0.0)
Requires-Dist: textstat (>=0.7.3,<0.8.0)
Requires-Dist: timeout-decorator (>=0.5.0,<0.6.0)
Requires-Dist: tldextract (>=2.2.2)
Requires-Dist: translate (>=3.6.1,<4.0.0)
Requires-Dist: wikipedia (>=1.4.0,<2.0.0)
Requires-Dist: wordfreq (>=3.0.3,<4.0.0)
Requires-Dist: wordhoard (>=1.5.4,<2.0.0)
Project-URL: Repository, https://github.com/apadua-org/apadata
Description-Content-Type: text/markdown

# Apadata



<div align="center">
 <h3>The library that empowers apadua with AI! 🚀</h3>

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](.pre-commit-config.yaml)
![Coverage Report](assets/images/coverage.svg)

</div>

## Very first steps

### Setup your environment

If you have not already setup your environment according to the SETUP guide of apadua, please do so before proceeding.  

[Setup Guide](https://github.com/apadua-org/setup)

### Initialize your code

1. If you don't have `Poetry` installed run:

```bash
make poetry-download
```

Make sure to add poetry to your PATH environment variable.  
For MacOS:
```bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zprofile
```


2. Initialize poetry and install `pre-commit` hooks:

```bash
make install
make pre-commit-install
```

3. Run the codestyle:

```bash
make codestyle
```

### Poetry

Want to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).

<details>
<summary>Details about Poetry</summary>
<p>

Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:

- `poetry add numpy@latest`
- `poetry run pytest`
- `poetry publish --build`

</p>
</details>

### Building and releasing your package

Building a new version of the application contains steps:

- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.
- Make a commit to `GitHub`.
- Create a `GitHub release`.
- And... publish 🙂 `poetry publish --build`


Articles:
- [GitHub Actions Documentation](https://help.github.com/en/actions).
- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. 😄

## 🚀 Features

### Development features

- Supports for `Python 3.8` and higher.
- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](pyproject.toml) and [`setup.cfg`](setup.cfg).
- Automatic codestyle with [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade).
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
- Type checks with [`mypy`](https://mypy.readthedocs.io); docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)
- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
- Ready-to-use [`.editorconfig`](.editorconfig), [`.dockerignore`](.dockerignore), and [`.gitignore`](.gitignore). You don't have to worry about those things.

### Deployment features

- `GitHub` integration: issue and pr templates.
- `Github Actions` with predefined [build workflow](.github/workflows/build.yml) as the default CI/CD.
- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](Makefile#L89). More details in [makefile-usage](#makefile-usage).
- [Dockerfile](docker/Dockerfile) for your package.
- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.

### Open source community features

- Ready-to-use [Pull Requests templates](.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](.github/ISSUE_TEMPLATE).
- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](.github/.stale.yml).
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).

### Makefile usage

[`Makefile`](Makefile) contains a lot of functions for faster development.

<details>
<summary>1. Download and remove Poetry</summary>
<p>

To download and install Poetry run:

```bash
make poetry-download
```

To uninstall

```bash
make poetry-remove
```

</p>
</details>

<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>

Install requirements:

```bash
make install
```

Pre-commit hooks coulb be installed after `git init` via

```bash
make pre-commit-install
```

</p>
</details>

<details>
<summary>3. Codestyle</summary>
<p>

Automatic formatting uses `pyupgrade`, `isort` and `black`.

```bash
make codestyle

# or use synonym
make formatting
```

Codestyle checks only, without rewriting files:

```bash
make check-codestyle
```

> Note: `check-codestyle` uses `isort`, `black` and `darglint` library

Update all dev libraries to the latest version using one comand

```bash
make update-dev-deps
```

<details>
<summary>4. Code security</summary>
<p>

```bash
make check-safety
```

This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.

```bash
make check-safety
```

</p>
</details>

</p>
</details>

<details>
<summary>5. Type checks</summary>
<p>

Run `mypy` static type checker

```bash
make mypy
```

</p>
</details>

<details>
<summary>6. Tests with coverage badges</summary>
<p>

Run `pytest`

```bash
make test
```

</p>
</details>

<details>
<summary>7. All linters</summary>
<p>

Of course there is a command to ~~rule~~ run all linters in one:

```bash
make lint
```

the same as:

```bash
make test && make check-codestyle && make mypy && make check-safety
```

</p>
</details>

<details>
<summary>8. Docker</summary>
<p>

```bash
make docker-build
```

which is equivalent to:

```bash
make docker-build VERSION=latest
```

Remove docker image with

```bash
make docker-remove
```

More information [about docker](docker).

</p>
</details>

<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files

```bash
make pycache-remove
```

Remove package build

```bash
make build-remove
```

Delete .DS_STORE files

```bash
make dsstore-remove
```

Remove .mypycache

```bash
make mypycache-remove
```

Or to remove all above run:

```bash
make cleanup
```

</p>
</details>

## 📈 Releases

You can see the list of available releases on the [GitHub Releases](https://github.com/apadua/apadata/releases) page.

We follow [Semantic Versions](https://semver.org/) specification.

We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

### List of labels and corresponding titles

|               **Label**               |  **Title in Releases**  |
| :-----------------------------------: | :---------------------: |
|       `enhancement`, `feature`        |       🚀 Features       |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring  |
|       `build`, `ci`, `testing`        | 📦 Build System & CI/CD |
|              `breaking`               |   💥 Breaking Changes   |
|            `documentation`            |    📝 Documentation     |
|            `dependencies`             | ⬆️ Dependencies updates |

You can update it in [`release-drafter.yml`](.github/release-drafter.yml).

GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

