pydantic-visualizer 0.1.0__tar.gz

pydantic_visualizer-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

pydantic_visualizer-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Install dependencies
+      run: |
+        uv pip install --system -e ".[dev]"
+
+    - name: Run tests
+      run: |
+        pytest --cov=pydantic_visualizer --cov-report=xml --cov-report=term-missing
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Install dependencies
+      run: |
+        uv pip install --system -e ".[dev]"
+
+    - name: Run ruff check
+      run: |
+        ruff check .
+
+    - name: Run ruff format check
+      run: |
+        ruff format --check .
+
+  type-check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Install dependencies
+      run: |
+        uv pip install --system -e ".[dev]"
+
+    - name: Run mypy
+      run: |
+        mypy pydantic_visualizer
+
+

pydantic_visualizer-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Install dependencies
+      run: |
+        uv pip install --system build twine
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Check package
+      run: |
+        twine check dist/*
+
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        twine upload dist/*
+
+

pydantic_visualizer-0.1.0/.gitignore

@@ -0,0 +1,195 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Package build artifacts
+*.egg
+*.egg-info/
+dist/
+build/
+*.whl
+
+# Example outputs
+examples/*.md
+examples/*.html
+output_diagram.*
+
+# 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
+.DS_Store
+uv.lock

pydantic_visualizer-0.1.0/LICENSE

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

pydantic_visualizer-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CONTRIBUTING.md
+include pyproject.toml
+
+recursive-include pydantic_visualizer *.py
+recursive-include tests *.py
+recursive-include examples *.py
+
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .DS_Store

pydantic_visualizer-0.1.0/PACKAGE_SETUP_COMPLETE.md

@@ -0,0 +1,220 @@
+# 🎉 Package Setup Complete!
+
+Your **pydantic-visualizer** project has been successfully transformed into a professional, open-source pip package!
+
+## ✅ What Has Been Done
+
+### 📁 Project Structure
+```
+pydantic-visualizer/
+├── .github/
+│   └── workflows/
+│       ├── ci.yml              # Continuous Integration
+│       └── publish.yml         # PyPI Publishing
+├── pydantic_visualizer/        # Main package directory
+│   ├── __init__.py            # Package initialization
+│   ├── generator.py           # Main generator class (refactored)
+│   └── type_checkers.py       # Type checking utilities
+├── tests/                      # Test suite
+│   ├── __init__.py
+│   ├── test_generator.py      # Generator tests
+│   └── test_type_checkers.py  # Type checker tests
+├── examples/
+│   └── basic_usage.py         # Usage examples
+├── .gitignore                 # Updated with package-specific ignores
+├── .gitattributes
+├── CHANGELOG.md               # Version history
+├── CONTRIBUTING.md            # Contribution guidelines
+├── LICENSE                    # MIT License
+├── MANIFEST.in                # Package manifest
+├── pyproject.toml             # Modern Python packaging config
+├── README.md                  # Comprehensive documentation
+├── SETUP_GUIDE.md             # Setup and publishing guide
+└── PACKAGE_SETUP_COMPLETE.md  # This file
+```
+
+### 🔧 Key Features Implemented
+
+1. **Modern Package Structure**
+   - Proper Python package with `__init__.py`
+   - Clean separation of concerns
+   - Fixed import paths (removed backend.utils references)
+
+2. **Build Configuration (pyproject.toml)**
+   - Uses `hatchling` as build backend
+   - Python 3.11+ requirement
+   - Comprehensive metadata (author, license, keywords)
+   - Development dependencies included
+   - Configured for `uv` package manager
+
+3. **Documentation**
+   - **README.md**: Installation, usage, examples, API reference
+   - **CONTRIBUTING.md**: Development setup, testing, PR guidelines
+   - **CHANGELOG.md**: Version history tracking
+   - **SETUP_GUIDE.md**: Detailed setup and publishing instructions
+   - Comprehensive docstrings in all modules
+
+4. **Testing Infrastructure**
+   - Full test suite with pytest
+   - Tests for generator functionality
+   - Tests for type checking utilities
+   - Coverage reporting configured
+
+5. **CI/CD Pipelines**
+   - **ci.yml**: Runs tests on multiple OS and Python versions
+   - **publish.yml**: Automated PyPI publishing on releases
+   - Linting with Ruff
+   - Type checking with MyPy
+
+6. **Code Quality Tools**
+   - Ruff for linting and formatting
+   - MyPy for type checking
+   - Pytest for testing
+   - All configured in pyproject.toml
+
+7. **Examples**
+   - Comprehensive usage examples
+   - Multiple scenarios covered
+   - Real-world use cases demonstrated
+
+## 🚀 Next Steps
+
+### 1. Install Dependencies
+
+```bash
+# Using uv (recommended)
+uv pip install -e ".[dev]"
+
+# Or using pip
+pip install -e ".[dev]"
+```
+
+### 2. Run Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=pydantic_visualizer --cov-report=html
+```
+
+### 3. Try the Examples
+
+```bash
+python examples/basic_usage.py
+```
+
+### 4. Set Up GitHub Repository
+
+```bash
+# Initialize git (if not already done)
+git init
+git add .
+git commit -m "feat: initial package setup"
+
+# Add remote and push
+git remote add origin https://github.com/YOUR_USERNAME/pydantic-visualizer.git
+git branch -M main
+git push -u origin main
+```
+
+### 5. Configure GitHub Secrets
+
+For automated PyPI publishing:
+
+1. Get a PyPI API token from https://pypi.org/manage/account/
+2. Add it to GitHub: Settings → Secrets → Actions → New repository secret
+3. Name: `PYPI_API_TOKEN`
+4. Value: Your PyPI token
+
+### 6. Create Your First Release
+
+```bash
+# Tag the release
+git tag v0.1.0
+git push origin v0.1.0
+
+# Or create a release on GitHub UI
+# The publish workflow will automatically deploy to PyPI
+```
+
+## 📦 Publishing Checklist
+
+Before publishing to PyPI:
+
+- [ ] All tests pass locally
+- [ ] Documentation is complete and accurate
+- [ ] CHANGELOG.md is updated
+- [ ] Version number is correct in pyproject.toml and __init__.py
+- [ ] Examples work correctly
+- [ ] GitHub Actions are configured
+- [ ] PyPI API token is set in GitHub secrets
+- [ ] README badges are updated (after first publish)
+
+## 🔍 Package Information
+
+- **Package Name**: `pydantic-visualizer`
+- **Version**: `0.1.0`
+- **Python Requirement**: `>=3.11`
+- **License**: MIT
+- **Main Dependency**: `pydantic>=2.0.0`
+
+## 📚 Important Files to Review
+
+1. **pyproject.toml** - Package configuration and metadata
+2. **README.md** - User-facing documentation
+3. **SETUP_GUIDE.md** - Development and publishing guide
+4. **CONTRIBUTING.md** - Contribution guidelines
+
+## 🎯 Installation (After Publishing)
+
+Once published to PyPI, users can install with:
+
+```bash
+# Using pip
+pip install pydantic-visualizer
+
+# Using uv
+uv pip install pydantic-visualizer
+```
+
+## 💡 Tips
+
+- Keep CHANGELOG.md updated with each release
+- Use semantic versioning (MAJOR.MINOR.PATCH)
+- Test on TestPyPI before publishing to PyPI
+- Run all quality checks before committing
+- Write clear commit messages (use conventional commits)
+
+## 🐛 Troubleshooting
+
+If you encounter issues:
+
+1. Check SETUP_GUIDE.md for detailed instructions
+2. Ensure all dependencies are installed
+3. Verify Python version is 3.11+
+4. Clear cache: `rm -rf build/ dist/ *.egg-info/`
+5. Reinstall: `uv pip install -e ".[dev]"`
+
+## 📞 Support
+
+- **Issues**: https://github.com/maxime-gillot/pydantic-visualizer/issues
+- **Discussions**: https://github.com/maxime-gillot/pydantic-visualizer/discussions
+
+## 🎊 Congratulations!
+
+Your package is now ready for the world! 🌍
+
+The project follows Python packaging best practices and is set up for:
+- Easy installation via pip/uv
+- Automated testing and quality checks
+- Continuous integration
+- Automated publishing
+- Community contributions
+
+**Happy coding and sharing! 🚀**
+
+---
+
+*Generated on: 2026-03-11*