drf-to-mkdoc 0.1.0__tar.gz → 0.1.3__tar.gz

drf_to_mkdoc-0.1.3/.github/workflows/publish.yaml

@@ -0,0 +1,43 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on tags like v1.0.0
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi  # Make sure this environment exists in repo settings
+
+    permissions:
+      contents: read
+      id-token: write  # Required for PyPI trusted publishing
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install build tools and setuptools_scm
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools_scm[toml]
+
+      - name: Verify version detection
+        run: |
+          echo "Detected version: $(python -m setuptools_scm)"
+          echo "Git describe: $(git describe --tags)"
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

drf_to_mkdoc-0.1.3/CONTRIBUTING.md

@@ -0,0 +1,127 @@
+# Contributing to DRF to MkDocs
+
+Thank you for your interest in contributing to DRF to MkDocs! This document provides guidelines and information for contributors.
+
+## Getting Started
+
+1. **Fork the repository**
+   - Go to the main repository page
+   - Click the "Fork" button to create your own copy
+
+2. **Clone your fork**
+   ```bash
+   git clone https://github.com/yourusername/drf-to-mkdoc.git
+   cd drf-to-mkdoc
+   ```
+
+3. **Set up development environment**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+4. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+## Development Guidelines
+
+### Code Style
+
+- Follow PEP 8 style guidelines
+- Use meaningful variable and function names
+- Add docstrings to all public functions and classes
+- Keep functions focused and single-purpose
+
+### Documentation
+
+- Update README.md if adding new features
+- Add docstrings to new functions and classes
+- Update inline comments for complex logic
+- Consider adding examples for new functionality
+
+## Making Changes
+
+1. **Make your changes**
+   - Implement your feature or fix
+   - Follow the coding guidelines above
+   - Test your changes thoroughly
+
+2. **Commit your changes**
+   ```bash
+   git add .
+   git commit -m "Add feature: brief description of changes"
+   ```
+
+3. **Push to your fork**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+4. **Create a pull request**
+   - Go to your fork on GitHub
+   - Click "New Pull Request"
+   - Select your feature branch
+   - Fill out the pull request template
+
+## Pull Request Guidelines
+
+### Before Submitting
+
+- [ ] Code follows style guidelines
+- [ ] Documentation is updated
+- [ ] No breaking changes (or clearly documented)
+- [ ] Feature is tested with multiple Django versions
+
+### Pull Request Template
+
+```markdown
+## Description
+Brief description of the changes made.
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Code refactoring
+
+## Testing
+Describe how you tested your changes.
+
+## Checklist
+- [ ] My code follows the style guidelines
+- [ ] I have performed a self-review
+- [ ] I have commented my code where necessary
+- [ ] I have made corresponding changes to documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective
+```
+
+## Issue Reporting
+
+When reporting issues, please include:
+
+- **Django version**: The version you're using
+- **DRF version**: Django REST Framework version
+- **Python version**: Your Python version
+- **Error message**: Full error traceback
+- **Steps to reproduce**: Clear steps to reproduce the issue
+- **Expected behavior**: What you expected to happen
+- **Actual behavior**: What actually happened
+
+## Code of Conduct
+
+- Be respectful and inclusive
+- Focus on the code and technical discussions
+- Help others learn and improve
+- Report any inappropriate behavior to maintainers
+
+## Questions?
+
+If you have questions about contributing, feel free to:
+
+- Open an issue for general questions
+- Ask in pull request comments
+- Contact maintainers directly
+
+Thank you for contributing to DRF to MkDocs! 

{drf_to_mkdoc-0.1.0 → drf_to_mkdoc-0.1.3}/LICENSE

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

{drf_to_mkdoc-0.1.0 → drf_to_mkdoc-0.1.3}/MANIFEST.in

@@ -1,18 +1,18 @@
-include README.md
-include LICENSE
-include MANIFEST.in
-include pyproject.toml
-
-recursive-include drf_to_mkdoc/conf *.py
-recursive-include drf_to_mkdoc/utils *.py
-recursive-include drf_to_mkdoc/management *.py
-
-global-exclude *.pyc
-global-exclude *.pyo
-global-exclude __pycache__
-global-exclude .DS_Store
-global-exclude .git*
-global-exclude .idea
-global-exclude .venv
-global-exclude .env
-global-exclude *.log
+include README.md
+include LICENSE
+include MANIFEST.in
+include pyproject.toml
+
+recursive-include drf_to_mkdoc/conf *.py
+recursive-include drf_to_mkdoc/utils *.py
+recursive-include drf_to_mkdoc/management *.py
+
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__
+global-exclude .DS_Store
+global-exclude .git*
+global-exclude .idea
+global-exclude .venv
+global-exclude .env
+global-exclude *.log