myco-ai


Namemyco-ai JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryMyco AI is a mycology assistant.
upload_time2023-07-18 22:10:39
maintainer
docs_urlNone
authorMark Beacom
requires_python>=3.8,<4.0
licenseMIT
keywords app cli mycology ai
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # myco-ai

[![Validation Workflow](https://github.com/mbeacom/myco-ai/actions/workflows/validate.yaml/badge.svg?branch=main&event=push)](https://github.com/mbeacom/myco-ai/actions/workflows/validate.yaml)
[![Pre-Commit Checks Workflow](https://github.com/mbeacom/myco-ai/actions/workflows/pre-commit.yaml/badge.svg?branch=main&event=push)](https://github.com/mbeacom/myco-ai/actions/workflows/pre-commit.yaml)
[![Coverage Status](https://codecov.io/github/mbeacom/myco-ai/coverage.svg?branch=main)](https://codecov.io/github/mbeacom/myco-ai?branch=main)
[![PyPi](https://img.shields.io/pypi/v/myco-ai-x)](https://pypi.org/project/myco-ai-x/)

This project is meant to be an assistant for mycologists.

## Usage

This project uses:

- [poetry](https://python-poetry.org/) for dependency management and packaging.
- [poethepoet](https://poethepoet.natn.io/) for task running.
- [pytest](https://docs.pytest.org/en/stable/) for testing.
- [black](https://black.readthedocs.io/en/stable/) for auto-formatting.
- [mypy](https://mypy.readthedocs.io/en/stable/) for static type checking.
- [pre-commit](https://pre-commit.com/) for git hooks.
- [ruff](https://beta.ruff.rs/docs/) for linting.
- [mkdocs](https://www.mkdocs.org/) for documentation.

Ensure you have installed the relevant dependencies before continuing.

### Install dependencies

```bash
poetry install
```

### Run tests

```bash
poetry poe test
# or: poetry run poe test
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "myco-ai",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "app,cli,mycology,ai",
    "author": "Mark Beacom",
    "author_email": "m@beacom.dev",
    "download_url": "https://files.pythonhosted.org/packages/ea/1b/285dd20c11a633c615886fdbbc2a87c71991d2a937cc9d924412c0fe4d54/myco_ai-0.1.0.tar.gz",
    "platform": null,
    "description": "# myco-ai\n\n[![Validation Workflow](https://github.com/mbeacom/myco-ai/actions/workflows/validate.yaml/badge.svg?branch=main&event=push)](https://github.com/mbeacom/myco-ai/actions/workflows/validate.yaml)\n[![Pre-Commit Checks Workflow](https://github.com/mbeacom/myco-ai/actions/workflows/pre-commit.yaml/badge.svg?branch=main&event=push)](https://github.com/mbeacom/myco-ai/actions/workflows/pre-commit.yaml)\n[![Coverage Status](https://codecov.io/github/mbeacom/myco-ai/coverage.svg?branch=main)](https://codecov.io/github/mbeacom/myco-ai?branch=main)\n[![PyPi](https://img.shields.io/pypi/v/myco-ai-x)](https://pypi.org/project/myco-ai-x/)\n\nThis project is meant to be an assistant for mycologists.\n\n## Usage\n\nThis project uses:\n\n- [poetry](https://python-poetry.org/) for dependency management and packaging.\n- [poethepoet](https://poethepoet.natn.io/) for task running.\n- [pytest](https://docs.pytest.org/en/stable/) for testing.\n- [black](https://black.readthedocs.io/en/stable/) for auto-formatting.\n- [mypy](https://mypy.readthedocs.io/en/stable/) for static type checking.\n- [pre-commit](https://pre-commit.com/) for git hooks.\n- [ruff](https://beta.ruff.rs/docs/) for linting.\n- [mkdocs](https://www.mkdocs.org/) for documentation.\n\nEnsure you have installed the relevant dependencies before continuing.\n\n### Install dependencies\n\n```bash\npoetry install\n```\n\n### Run tests\n\n```bash\npoetry poe test\n# or: poetry run poe test\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Myco AI is a mycology assistant.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "app",
        "cli",
        "mycology",
        "ai"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c67884ec8ecb926121bba06150c538264587f611c85fdb9464499530c1a51f51",
                "md5": "aa4e62f0406806829071d5b8744b6bbb",
                "sha256": "c3ce5a016a0967a7205b4a6d31a181d03c31670856b9bc8b079c200f32a36b02"
            },
            "downloads": -1,
            "filename": "myco_ai-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aa4e62f0406806829071d5b8744b6bbb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 3687,
            "upload_time": "2023-07-18T22:10:37",
            "upload_time_iso_8601": "2023-07-18T22:10:37.880016Z",
            "url": "https://files.pythonhosted.org/packages/c6/78/84ec8ecb926121bba06150c538264587f611c85fdb9464499530c1a51f51/myco_ai-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea1b285dd20c11a633c615886fdbbc2a87c71991d2a937cc9d924412c0fe4d54",
                "md5": "d910845fad3364e541a14ff87365c398",
                "sha256": "8e96729d035dd75e708c345af93130f7e82d1343fa31f7a6d40b43844a551625"
            },
            "downloads": -1,
            "filename": "myco_ai-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d910845fad3364e541a14ff87365c398",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 3646,
            "upload_time": "2023-07-18T22:10:39",
            "upload_time_iso_8601": "2023-07-18T22:10:39.114826Z",
            "url": "https://files.pythonhosted.org/packages/ea/1b/285dd20c11a633c615886fdbbc2a87c71991d2a937cc9d924412c0fe4d54/myco_ai-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-18 22:10:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "myco-ai"
}
        
Elapsed time: 0.27193s