goldfish-backend


Namegoldfish-backend JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryAI-First Personal Knowledge Management - Shared Backend
upload_time2025-07-08 19:21:51
maintainerNone
docs_urlNone
authorGoldfish Team
requires_python>=3.11
licenseMIT License Copyright (c) 2025 Goldfish Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords ai backend entities knowledge management notes
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Goldfish Backend

Shared backend package for the Goldfish AI-First Personal Knowledge Management system.

## Overview

This package contains the core shared components used by both the Goldfish CLI and web application:

- **Models**: SQLModel database models for all entities
- **Services**: Business logic layer for entity recognition and management
- **Core**: Database connection, authentication, and utility functions
- **CLI**: Command-line interface components

## Installation

```bash
pip install goldfish-backend
```

## Usage

This package is designed to be used as a dependency by the Goldfish CLI and web application. It provides the shared data layer and business logic.

### In your code:

```python
from goldfish_backend.models import User, Person, Project, Task
from goldfish_backend.services import EntityRecognitionService
from goldfish_backend.core.database import get_session
```

## Development

```bash
# Install with development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run type checking
mypy src/

# Format code
black src/ tests/
```

## Architecture

- `models/`: SQLModel database models
- `services/`: Business logic services
- `core/`: Core utilities (database, auth)
- `cli/`: Command-line interface components

## License

MIT License
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "goldfish-backend",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "ai, backend, entities, knowledge, management, notes",
    "author": "Goldfish Team",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/71/4e/44e1eac9bc918ff19c60faa631ed29bb47441a00030baa22619f8cef2f76/goldfish_backend-0.1.0.tar.gz",
    "platform": null,
    "description": "# Goldfish Backend\n\nShared backend package for the Goldfish AI-First Personal Knowledge Management system.\n\n## Overview\n\nThis package contains the core shared components used by both the Goldfish CLI and web application:\n\n- **Models**: SQLModel database models for all entities\n- **Services**: Business logic layer for entity recognition and management\n- **Core**: Database connection, authentication, and utility functions\n- **CLI**: Command-line interface components\n\n## Installation\n\n```bash\npip install goldfish-backend\n```\n\n## Usage\n\nThis package is designed to be used as a dependency by the Goldfish CLI and web application. It provides the shared data layer and business logic.\n\n### In your code:\n\n```python\nfrom goldfish_backend.models import User, Person, Project, Task\nfrom goldfish_backend.services import EntityRecognitionService\nfrom goldfish_backend.core.database import get_session\n```\n\n## Development\n\n```bash\n# Install with development dependencies\npip install -e \".[dev]\"\n\n# Run tests\npytest\n\n# Run type checking\nmypy src/\n\n# Format code\nblack src/ tests/\n```\n\n## Architecture\n\n- `models/`: SQLModel database models\n- `services/`: Business logic services\n- `core/`: Core utilities (database, auth)\n- `cli/`: Command-line interface components\n\n## License\n\nMIT License",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Goldfish Team\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "AI-First Personal Knowledge Management - Shared Backend",
    "version": "0.1.0",
    "project_urls": {
        "Bug Reports": "https://github.com/linxichen/goldfish/issues",
        "Documentation": "https://github.com/linxichen/goldfish/tree/main/goldfish-backend",
        "Homepage": "https://github.com/linxichen/goldfish",
        "Repository": "https://github.com/linxichen/goldfish"
    },
    "split_keywords": [
        "ai",
        " backend",
        " entities",
        " knowledge",
        " management",
        " notes"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4b8fa0dd8295f24cde77f36b9d7f03d26268f1b3e2da1786b7c91157cdd43445",
                "md5": "395ff37492ab404b05196a2d19d914d2",
                "sha256": "c56efd893a41f9949db8ea508f635b2f8015ff9cc05eba90b34d093442d8a1a8"
            },
            "downloads": -1,
            "filename": "goldfish_backend-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "395ff37492ab404b05196a2d19d914d2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 39530,
            "upload_time": "2025-07-08T19:21:50",
            "upload_time_iso_8601": "2025-07-08T19:21:50.127331Z",
            "url": "https://files.pythonhosted.org/packages/4b/8f/a0dd8295f24cde77f36b9d7f03d26268f1b3e2da1786b7c91157cdd43445/goldfish_backend-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "714e44e1eac9bc918ff19c60faa631ed29bb47441a00030baa22619f8cef2f76",
                "md5": "ecc243941f0fedb33598cd84039a0a88",
                "sha256": "9539e4b207f5bf93c262cc81b43fe43320fd3efaa69ad1d3ce63e59e56adc935"
            },
            "downloads": -1,
            "filename": "goldfish_backend-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ecc243941f0fedb33598cd84039a0a88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 27856,
            "upload_time": "2025-07-08T19:21:51",
            "upload_time_iso_8601": "2025-07-08T19:21:51.303772Z",
            "url": "https://files.pythonhosted.org/packages/71/4e/44e1eac9bc918ff19c60faa631ed29bb47441a00030baa22619f8cef2f76/goldfish_backend-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 19:21:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "linxichen",
    "github_project": "goldfish",
    "github_not_found": true,
    "lcname": "goldfish-backend"
}
        
Elapsed time: 0.41361s