# dsalgo
A package for Datastructures and Algorithms written in Python.
[![Python package][ci-badge]][ci-url]
[![PyPI version][pypi-badge]][pypi-url]
[![License: MIT][mit-badge]][mit-url]
[![pre-commit][pre-commit-badge]][pre-commit-url]
[![Github pages][gh-pages-badge]][gh-pages-url]
[ci-badge]: https://github.com/kagemeka/dsalgo-python/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/kagemeka/dsalgo-python/actions/workflows/ci.yml
[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
[pre-commit-url]: https://github.com/pre-commit/pre-commit
[mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg
[mit-url]: https://opensource.org/licenses/MIT
[pypi-badge]: https://badge.fury.io/py/dsalgo.svg
[pypi-url]: https://badge.fury.io/py/dsalgo
[gh-pages-badge]: https://github.com/kagemeka/dsalgo-python/actions/workflows/pages/pages-build-deployment/badge.svg
[gh-pages-url]: https://kagemeka.github.io/dsalgo-python
## Installation
```bash
python3 -m pip install -U dsalgo
# to use numba functionality for python <3.11
python3 -m pip install -U dsalgo[nb]
# for latest unstable version
python3 -m pip install -U git+git://github.com/kagemeka/dsalgo-python.git
```
## Development
```sh
docker compose up -d
```
(enter the container)
```sh
./setup.sh
source ~/.bashrc
```
CI before commit
```sh
./ci.sh
```
### documenting
```sh
poetry run pdoc dsalgo --show-source --math -o docs
```
### publish
```sh
poetry config pypi-token.pypi <your token> # only once
poetry build
poetry publish
```
Raw data
{
"_id": null,
"home_page": "https://github.com/kagemeka/dsalgo-python#readme",
"name": "dsalgo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "algorithm,datastructure",
"author": "kagemeka",
"author_email": "kagemeka1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/a4/ce107a1a0af3c981a7b44d984feef7e5bd02285b7131d26c2d4eaed9b653/dsalgo-0.3.7.tar.gz",
"platform": null,
"description": "\n# dsalgo\n\nA package for Datastructures and Algorithms written in Python.\n\n[![Python package][ci-badge]][ci-url]\n[![PyPI version][pypi-badge]][pypi-url]\n[![License: MIT][mit-badge]][mit-url]\n[![pre-commit][pre-commit-badge]][pre-commit-url]\n[![Github pages][gh-pages-badge]][gh-pages-url]\n\n[ci-badge]: https://github.com/kagemeka/dsalgo-python/actions/workflows/ci.yml/badge.svg\n[ci-url]: https://github.com/kagemeka/dsalgo-python/actions/workflows/ci.yml\n[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n[pre-commit-url]: https://github.com/pre-commit/pre-commit\n[mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg\n[mit-url]: https://opensource.org/licenses/MIT\n[pypi-badge]: https://badge.fury.io/py/dsalgo.svg\n[pypi-url]: https://badge.fury.io/py/dsalgo\n[gh-pages-badge]: https://github.com/kagemeka/dsalgo-python/actions/workflows/pages/pages-build-deployment/badge.svg\n[gh-pages-url]: https://kagemeka.github.io/dsalgo-python\n\n## Installation\n\n```bash\npython3 -m pip install -U dsalgo\n\n# to use numba functionality for python <3.11\npython3 -m pip install -U dsalgo[nb]\n\n# for latest unstable version\npython3 -m pip install -U git+git://github.com/kagemeka/dsalgo-python.git\n```\n\n## Development\n\n```sh\ndocker compose up -d\n```\n\n(enter the container)\n\n```sh\n./setup.sh\nsource ~/.bashrc\n```\n\nCI before commit\n\n```sh\n./ci.sh\n```\n\n### documenting\n\n```sh\npoetry run pdoc dsalgo --show-source --math -o docs\n```\n\n### publish\n\n```sh\npoetry config pypi-token.pypi <your token> # only once\npoetry build\npoetry publish\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package for datastructures and algorithms.",
"version": "0.3.7",
"split_keywords": [
"algorithm",
"datastructure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "149a4af2a17eb45f68936a26f822a8cbb4a9059049a49c89a38121fffd77a7e4",
"md5": "6954a10e464361e5c74763bed99a5ad9",
"sha256": "de0029f7430e781992fd4166133033099bf5f09b0ae57289c227b60c9d9df4c9"
},
"downloads": -1,
"filename": "dsalgo-0.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6954a10e464361e5c74763bed99a5ad9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 14552,
"upload_time": "2023-02-07T22:41:27",
"upload_time_iso_8601": "2023-02-07T22:41:27.454022Z",
"url": "https://files.pythonhosted.org/packages/14/9a/4af2a17eb45f68936a26f822a8cbb4a9059049a49c89a38121fffd77a7e4/dsalgo-0.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01a4ce107a1a0af3c981a7b44d984feef7e5bd02285b7131d26c2d4eaed9b653",
"md5": "e517acdfaf486c9e949b028d917ea98e",
"sha256": "58117167c5ede1d632e3604b7a9104871c7f6e8754785cbc67f40b76210ccb6b"
},
"downloads": -1,
"filename": "dsalgo-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "e517acdfaf486c9e949b028d917ea98e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 8686,
"upload_time": "2023-02-07T22:41:29",
"upload_time_iso_8601": "2023-02-07T22:41:29.073962Z",
"url": "https://files.pythonhosted.org/packages/01/a4/ce107a1a0af3c981a7b44d984feef7e5bd02285b7131d26c2d4eaed9b653/dsalgo-0.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-07 22:41:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kagemeka",
"github_project": "dsalgo-python#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "dsalgo"
}
JSON
