graphfleet


Namegraphfleet JSON
Version 0.7.5 PyPI version JSON
download
home_pageNone
SummaryA graph-based knowledge management and query system
upload_time2024-12-25 22:48:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords graph knowledge search semantic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GraphFleet

A powerful graph-based knowledge management and query system designed for large-scale data processing and analysis. GraphFleet combines semantic search, knowledge graphs, and advanced analytics to provide deep insights into your data.

## ๐Ÿš€ Key Features

- **Advanced Document Processing**
  - Semantic indexing and search
  - Automatic knowledge graph construction
  - Multi-format document support (PDF, Markdown, Code, etc.)

- **Graph Analytics**
  - Custom query pipelines
  - Concept drift analysis
  - Community detection
  - Path analysis and recommendations

- **Performance & Scale**
  - Distributed processing support
  - Native extensions for performance-critical operations
  - Efficient batch processing
  - Real-time query capabilities

- **Developer Experience**
  - Modern React frontend
  - RESTful and GraphQL APIs
  - Comprehensive documentation
  - Docker-based development environment

## ๐Ÿ—๏ธ Architecture

GraphFleet consists of three main components:

1. **Core Engine (graphfleet)**
   - Document processing and indexing
   - Knowledge graph management
   - Query processing

2. **Graph Processing (graspologic)**
   - Graph algorithms implementation
   - Analytics and metrics
   - Visualization utilities

3. **Native Extensions (graspologic-native)**
   - Performance-critical operations in Rust
   - SIMD optimizations
   - Custom memory management

## ๐Ÿ› ๏ธ Installation

### Using uv

```bash
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install graphfleet
uv pip install graphfleet[all]
```

### Development Setup

1. Clone the repository:
```bash
git clone https://github.com/qredence/graphfleet.git
cd graphfleet
```

2. Set up development environment:
```bash
# Using Docker (recommended)
docker compose up -d

# Or manual setup
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies with uv
uv pip install --upgrade uv  # Ensure latest uv version
uv pip install build hatchling  # Install build tools
uv sync  # Install all dependencies from pyproject.toml
uv pip install -e ".[dev]"  # Install package in editable mode
```

3. Configure environment:
```bash
cp .env.example .env
# Edit .env with your settings
```

## ๐Ÿ“š Documentation

- [Getting Started Guide](./docs/guides/getting-started.md)
- [API Reference](./docs/api/README.md)
- [Architecture Overview](./docs/architecture/README.md)
- [Contributing Guidelines](./CONTRIBUTING.md)

## ๐Ÿงช Examples

The `examples/` directory contains various use cases and tutorials:

- Basic document indexing and search
- Custom query pipeline creation
- Knowledge graph visualization
- Performance optimization techniques

## ๐Ÿ›ฃ๏ธ Project Structure

```
graphfleet/
โ”œโ”€โ”€ backend/                    # Backend service
โ”‚   โ”œโ”€โ”€ app/                   # Main application code
โ”‚   โ”‚   โ”œโ”€โ”€ api/              # API endpoints
โ”‚   โ”‚   โ”œโ”€โ”€ core/             # Core business logic
โ”‚   โ”‚   โ”œโ”€โ”€ models/           # Data models
โ”‚   โ”‚   โ””โ”€โ”€ utils/            # Utility functions
โ”‚   โ”œโ”€โ”€ graphfleet/           # GraphFleet core library
โ”‚   โ””โ”€โ”€ tests/                # Backend tests
โ”œโ”€โ”€ graspologic/               # Graph processing library
โ”‚   โ”œโ”€โ”€ src/                  # Source code
โ”‚   โ”œโ”€โ”€ tests/                # Tests
โ”‚   โ””โ”€๏ฟฝ๏ฟฝ docs/                 # Library documentation
โ”œโ”€โ”€ graspologic-native/        # Native extensions
โ”‚   โ”œโ”€โ”€ src/                  # Rust/C++ source
โ”‚   โ””โ”€โ”€ python/               # Python bindings
โ”œโ”€โ”€ frontend/                  # Frontend application
โ””โ”€โ”€ docs/                     # Project documentation
```

## ๐Ÿค Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

### Development Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and linting
5. Submit a pull request

## ๐Ÿ“„ License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

## ๐Ÿ”’ Security

For security concerns, please refer to our [Security Policy](SECURITY.md).

## ๐ŸŒŸ Acknowledgments

GraphFleet is built on top of several amazing open-source projects:

- [NetworkX](https://networkx.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [React](https://reactjs.org/)
- [sentence-transformers](https://www.sbert.net/)

## โœจ Core Team

- Zachary BENSALEM ([@zbensalem](https://github.com/zbensalem)) - Project Lead

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "graphfleet",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "graph, knowledge, search, semantic",
    "author": null,
    "author_email": "Zachary BENSALEM <contact@qreddence.ai>",
    "download_url": "https://files.pythonhosted.org/packages/d8/9d/b87c21808f7f541350ed26f52dab7239efe32bfe3ac617160307135e28aa/graphfleet-0.7.5.tar.gz",
    "platform": null,
    "description": "# GraphFleet\n\nA powerful graph-based knowledge management and query system designed for large-scale data processing and analysis. GraphFleet combines semantic search, knowledge graphs, and advanced analytics to provide deep insights into your data.\n\n## \ud83d\ude80 Key Features\n\n- **Advanced Document Processing**\n  - Semantic indexing and search\n  - Automatic knowledge graph construction\n  - Multi-format document support (PDF, Markdown, Code, etc.)\n\n- **Graph Analytics**\n  - Custom query pipelines\n  - Concept drift analysis\n  - Community detection\n  - Path analysis and recommendations\n\n- **Performance & Scale**\n  - Distributed processing support\n  - Native extensions for performance-critical operations\n  - Efficient batch processing\n  - Real-time query capabilities\n\n- **Developer Experience**\n  - Modern React frontend\n  - RESTful and GraphQL APIs\n  - Comprehensive documentation\n  - Docker-based development environment\n\n## \ud83c\udfd7\ufe0f Architecture\n\nGraphFleet consists of three main components:\n\n1. **Core Engine (graphfleet)**\n   - Document processing and indexing\n   - Knowledge graph management\n   - Query processing\n\n2. **Graph Processing (graspologic)**\n   - Graph algorithms implementation\n   - Analytics and metrics\n   - Visualization utilities\n\n3. **Native Extensions (graspologic-native)**\n   - Performance-critical operations in Rust\n   - SIMD optimizations\n   - Custom memory management\n\n## \ud83d\udee0\ufe0f Installation\n\n### Using uv\n\n```bash\n# Install uv if you haven't already\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Install graphfleet\nuv pip install graphfleet[all]\n```\n\n### Development Setup\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/qredence/graphfleet.git\ncd graphfleet\n```\n\n2. Set up development environment:\n```bash\n# Using Docker (recommended)\ndocker compose up -d\n\n# Or manual setup\npython -m venv .venv\nsource .venv/bin/activate  # On Windows: .venv\\Scripts\\activate\n\n# Install dependencies with uv\nuv pip install --upgrade uv  # Ensure latest uv version\nuv pip install build hatchling  # Install build tools\nuv sync  # Install all dependencies from pyproject.toml\nuv pip install -e \".[dev]\"  # Install package in editable mode\n```\n\n3. Configure environment:\n```bash\ncp .env.example .env\n# Edit .env with your settings\n```\n\n## \ud83d\udcda Documentation\n\n- [Getting Started Guide](./docs/guides/getting-started.md)\n- [API Reference](./docs/api/README.md)\n- [Architecture Overview](./docs/architecture/README.md)\n- [Contributing Guidelines](./CONTRIBUTING.md)\n\n## \ud83e\uddea Examples\n\nThe `examples/` directory contains various use cases and tutorials:\n\n- Basic document indexing and search\n- Custom query pipeline creation\n- Knowledge graph visualization\n- Performance optimization techniques\n\n## \ud83d\udee3\ufe0f Project Structure\n\n```\ngraphfleet/\n\u251c\u2500\u2500 backend/                    # Backend service\n\u2502   \u251c\u2500\u2500 app/                   # Main application code\n\u2502   \u2502   \u251c\u2500\u2500 api/              # API endpoints\n\u2502   \u2502   \u251c\u2500\u2500 core/             # Core business logic\n\u2502   \u2502   \u251c\u2500\u2500 models/           # Data models\n\u2502   \u2502   \u2514\u2500\u2500 utils/            # Utility functions\n\u2502   \u251c\u2500\u2500 graphfleet/           # GraphFleet core library\n\u2502   \u2514\u2500\u2500 tests/                # Backend tests\n\u251c\u2500\u2500 graspologic/               # Graph processing library\n\u2502   \u251c\u2500\u2500 src/                  # Source code\n\u2502   \u251c\u2500\u2500 tests/                # Tests\n\u2502   \u2514\u2500\ufffd\ufffd docs/                 # Library documentation\n\u251c\u2500\u2500 graspologic-native/        # Native extensions\n\u2502   \u251c\u2500\u2500 src/                  # Rust/C++ source\n\u2502   \u2514\u2500\u2500 python/               # Python bindings\n\u251c\u2500\u2500 frontend/                  # Frontend application\n\u2514\u2500\u2500 docs/                     # Project documentation\n```\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n### Development Process\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Run tests and linting\n5. Submit a pull request\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\udd12 Security\n\nFor security concerns, please refer to our [Security Policy](SECURITY.md).\n\n## \ud83c\udf1f Acknowledgments\n\nGraphFleet is built on top of several amazing open-source projects:\n\n- [NetworkX](https://networkx.org/)\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [React](https://reactjs.org/)\n- [sentence-transformers](https://www.sbert.net/)\n\n## \u2728 Core Team\n\n- Zachary BENSALEM ([@zbensalem](https://github.com/zbensalem)) - Project Lead\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A graph-based knowledge management and query system",
    "version": "0.7.5",
    "project_urls": null,
    "split_keywords": [
        "graph",
        " knowledge",
        " search",
        " semantic"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0c690b6eb1b0a2683dcb86760838dd7854c7de7d7b3ce55aa12a19e9919d2bfc",
                "md5": "95a20ae6fc81f4a710c547321ccdb290",
                "sha256": "83537a199993c151f88c6476739f2414af37c0691b381f210653e465250ed5fc"
            },
            "downloads": -1,
            "filename": "graphfleet-0.7.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "95a20ae6fc81f4a710c547321ccdb290",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 53229,
            "upload_time": "2024-12-25T22:48:15",
            "upload_time_iso_8601": "2024-12-25T22:48:15.901452Z",
            "url": "https://files.pythonhosted.org/packages/0c/69/0b6eb1b0a2683dcb86760838dd7854c7de7d7b3ce55aa12a19e9919d2bfc/graphfleet-0.7.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d89db87c21808f7f541350ed26f52dab7239efe32bfe3ac617160307135e28aa",
                "md5": "78c02181214052f31d5984160e9eae38",
                "sha256": "634c7bc992b036ec3f82a1b2ecb99c3b57778756d4db2f4542b4732fabd4da2d"
            },
            "downloads": -1,
            "filename": "graphfleet-0.7.5.tar.gz",
            "has_sig": false,
            "md5_digest": "78c02181214052f31d5984160e9eae38",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 34903,
            "upload_time": "2024-12-25T22:48:18",
            "upload_time_iso_8601": "2024-12-25T22:48:18.956962Z",
            "url": "https://files.pythonhosted.org/packages/d8/9d/b87c21808f7f541350ed26f52dab7239efe32bfe3ac617160307135e28aa/graphfleet-0.7.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-25 22:48:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "graphfleet"
}
        
Elapsed time: 1.32974s