pygraphile 0.1.0__tar.gz

pygraphile-0.1.0/.gitattributes

@@ -0,0 +1,35 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Python files
+*.py text eol=lf
+*.pyx text eol=lf
+*.pyi text eol=lf
+
+# Configuration files
+*.toml text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.txt text eol=lf
+
+# Shell scripts
+*.sh text eol=lf
+*.bash text eol=lf
+
+# Windows scripts
+*.bat text eol=crlf
+*.cmd text eol=crlf
+*.ps1 text eol=crlf
+
+# Binary files
+*.db binary
+*.sqlite binary
+*.sqlite3 binary
+*.pyc binary
+*.pyo binary
+*.pyd binary
+*.so binary
+*.dll binary
+*.dylib binary

pygraphile-0.1.0/.github/workflows/workflow.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Pygraphile 
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

pygraphile-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

pygraphile-0.1.0/.python-version

@@ -0,0 +1 @@
+3.9

pygraphile-0.1.0/AI_USAGE.md

@@ -0,0 +1,70 @@
+# AI Usage Records
+
+This file documents all AI-assisted contributions to the PyGraphile project, promoting transparency and accountability.
+
+## Purpose
+
+We believe in transparency when it comes to AI-assisted development. This file tracks:
+- Which changes were made with AI assistance
+- What those changes accomplish
+- Who was responsible for the contribution
+
+## Format
+
+Each entry should include:
+- **Date**: When the contribution was made
+- **Contributor**: GitHub username
+- **AI Tool**: Which AI tool was used (e.g., GitHub Copilot, ChatGPT, etc.)
+- **Changes Made**: Description of what was changed
+- **Explanation**: What the changes do (in contributor's own words)
+- **Commit(s)**: Related commit hash(es)
+
+---
+
+## Contribution Records
+
+### 2025-11-09 - Initial Package Structure
+
+**Contributor**: @copilot (GitHub Copilot Workspace Agent)  
+**AI Tool**: GitHub Copilot Workspace  
+**Commit**: 27bbaa4
+
+**Changes Made**:
+- Project initialization using `uv init --lib`
+- Complete package structure setup with src-layout
+- Configuration files (pyproject.toml, .python-version, .gitattributes)
+- Documentation files (README.md, LICENSE, CONTRIBUTING.md)
+- Test infrastructure (tests/ directory with basic tests)
+- Directory structure (src/pygraphile/, examples/, docs/, .github/workflows/)
+
+**What These Changes Do**:
+This AI-generated contribution established the foundational structure for the PyGraphile package. It created a modern Python package using the src-layout pattern, which separates source code from tests and configuration. The package is configured to work with both `uv` (a fast Python package manager) and traditional `pip`, ensuring broad compatibility. 
+
+Key components include:
+- **src/pygraphile/**: Main package directory containing `__init__.py` with package metadata
+- **pyproject.toml**: Project configuration defining dependencies, build system (hatchling for pip compatibility), development tools (pytest, ruff), and project metadata
+- **LICENSE**: MIT license for open-source distribution
+- **README.md**: User-facing documentation with installation instructions, features, and roadmap
+- **CONTRIBUTING.md**: Guidelines for contributors on how to set up development environment and contribute code
+- **tests/**: Test infrastructure using pytest with basic validation tests
+- **py.typed**: Marker file indicating the package supports type hints (PEP 561)
+
+The structure follows Python packaging best practices and provides a solid foundation for building the GraphQL API generation features.
+
+---
+
+## Guidelines for Future Entries
+
+When adding entries to this file:
+
+1. **Be Specific**: Clearly state what files or features were modified/created
+2. **Own Your Work**: Even if AI generated code, you must understand and explain it
+3. **No AI Explanations**: The "Explanation" section must be written by you, not AI
+4. **Be Honest**: Disclose the full extent of AI involvement
+5. **Update Promptly**: Add entries when you submit your PR, not after merge
+
+---
+
+## Questions?
+
+If you're unsure whether to disclose AI usage or how to format your entry, feel free to ask in your pull request or open an issue.

pygraphile-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing to PyGraphile
+
+Thank you for your interest in contributing to PyGraphile! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+Be respectful and inclusive. We want this to be a welcoming community for everyone.
+
+## How to Contribute
+
+### Reporting Bugs
+
+- Use the GitHub Issues tracker
+- Describe the bug in detail
+- Include steps to reproduce
+- Mention your Python version and OS
+
+### Suggesting Features
+
+- Open an issue with the "enhancement" label
+- Clearly describe the feature and its use case
+- Explain why it would be useful to most users
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a new branch for your feature or fix
+3. Write clear, commented code
+4. Add tests if applicable
+5. Ensure all tests pass
+6. Update documentation as needed
+7. Submit a pull request
+
+### AI Usage Disclosure
+
+Contributors are welcome to use AI tools to assist with their contributions. However, **you must disclose any AI-generated changes** in your pull request:
+
+- **List which changes were made with AI assistance** in the PR description
+- **Explain what those changes do in your own words** - do not use AI to write the explanation
+- Be transparent about the extent of AI involvement (e.g., "AI generated the initial structure", "AI helped refactor function X")
+- Take full responsibility for reviewing and understanding all AI-generated code before submitting
+
+This policy ensures transparency and helps maintain code quality and understanding across the project.
+
+## Development Setup
+
+### Using uv (recommended)
+
+```bash
+# Clone the repository
+git clone https://github.com/dshaw0004/pygraphile.git
+cd pygraphile
+
+# Install dependencies
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run ruff check .
+```
+
+### Using pip
+
+```bash
+# Clone the repository
+git clone https://github.com/dshaw0004/pygraphile.git
+cd pygraphile
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run linter
+ruff check .
+```
+
+## Code Style
+
+- Follow PEP 8 guidelines
+- Use type hints where appropriate
+- Write docstrings for public functions and classes
+- Keep functions focused and concise
+- Use meaningful variable names
+
+## Testing
+
+- Write tests for new features
+- Ensure existing tests pass
+- Aim for good test coverage
+- Use pytest for testing
+
+## Documentation
+
+- Update README.md for user-facing changes
+- Add docstrings to new functions/classes
+- Update examples if needed
+
+## Questions?
+
+Feel free to open an issue for any questions or clarifications!

pygraphile-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dshaw0004
+
+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.

pygraphile-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: pygraphile
+Version: 0.1.0
+Summary: A Python library inspired by PostGraphile - automatically generates GraphQL APIs from databases. Currently supports SQLite with plans for additional database support.
+Project-URL: Homepage, https://github.com/dshaw0004/pygraphile
+Project-URL: Repository, https://github.com/dshaw0004/pygraphile
+Project-URL: Issues, https://github.com/dshaw0004/pygraphile/issues
+Author: dshaw0004
+License: MIT
+License-File: LICENSE
+Keywords: api,database,graphql,postgraphile,sqlite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# PyGraphile
+
+[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python library inspired by [PostGraphile](https://www.graphile.org/postgraphile/) - automatically generates GraphQL APIs from your database schema.
+
+## 🚧 Project Status
+
+This project is in early development. Currently supporting SQLite with plans to add support for PostgreSQL, MySQL, and other databases in the future.
+
+## ✨ Features
+
+- 🗄️ **Database Introspection**: Automatically analyzes your database schema
+- 🔄 **GraphQL API Generation**: Creates a GraphQL API based on your database structure
+- 🎯 **SQLite Support**: Initial support for SQLite databases (more databases coming soon)
+- 🐍 **Python Native**: Built for Python with modern best practices
+- 📦 **Easy to Use**: Simple setup and configuration
+
+## 🚀 Installation
+
+### Using pip
+
+```bash
+pip install pygraphile
+```
+
+### Using uv
+
+```bash
+uv pip install pygraphile
+```
+
+### From source
+
+```bash
+git clone https://github.com/dshaw0004/pygraphile.git
+cd pygraphile
+uv pip install -e .
+```
+
+## 📖 Quick Start
+
+```python
+from pygraphile import Pygraphile
+
+# Coming soon! Basic usage example will be:
+# api = Pygraphile('path/to/database.db')
+# api.serve()
+```
+
+## 🗺️ Roadmap
+
+- [x] Project setup and structure
+- [ ] SQLite schema introspection
+- [ ] GraphQL schema generation
+- [ ] Query resolver implementation
+- [ ] Mutation support
+- [ ] PostgreSQL support
+- [ ] MySQL support
+- [ ] Advanced filtering and pagination
+- [ ] Authentication and authorization
+- [ ] Plugin system
+
+## 🤝 Contributing
+
+Contributions are welcome! This project is in early stages, so there's plenty of opportunity to shape its direction.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Inspired by [PostGraphile](https://www.graphile.org/postgraphile/) - An amazing tool for PostgreSQL
+- Built with modern Python tooling including [uv](https://github.com/astral-sh/uv)
+
+## 📬 Contact
+
+- GitHub: [@dshaw0004](https://github.com/dshaw0004)
+- Project Link: [https://github.com/dshaw0004/pygraphile](https://github.com/dshaw0004/pygraphile)
+
+---
+
+**Note**: This project is under active development. APIs and features are subject to change.