pysgn 0.1.0__tar.gz

pysgn-0.1.0/.github/ISSUE_TEMPLATE/asking-help.md

@@ -0,0 +1,9 @@
+---
+name: Asking for help
+about: If you need help using PySGN, you should post in https://github.com/wang-boyu/pysgn/discussions
+---
+
+<!--
+    ATTENTION: Don't raise an issue here!
+    If you need help, ask in https://github.com/wang-boyu/pysgn/discussions
+-->

pysgn-0.1.0/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Let us know if something is broken on PySGN
+
+---
+
+**Describe the bug**
+<!-- A clear and concise description the bug -->
+
+**Expected behavior**
+<!-- A clear and concise description of what you expected to happen -->
+
+**To Reproduce**
+<!-- Steps to reproduce the bug, or a link to a project where the bug is visible -->
+
+**Additional context**
+<!--
+    Add any other context here.
+    Any details about your specific platform:
+    * If the problem is in the browser, what browser, version, and OS?
+-->

pysgn-0.1.0/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest a new feature for PySGN
+
+---
+
+**What's the problem this feature will solve?**
+<!-- A clear and concise description of what the problem is. -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Additional context**
+<!-- Add any other context, links, etc. about the feature here. -->

pysgn-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,68 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+
+# This will cancel previous run if a newer job that obsoletes the said previous
+# run, is started.
+# Based on https://github.com/zulip/zulip/commit/4a11642cee3c8aec976d305d51a86e60e5d70522
+concurrency:
+  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}"
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ubuntu, macos, windows]
+        python-version: ["3.10", "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 }}
+        allow-prereleases: true
+        cache: 'pip'
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install uv
+        uv pip install --system .[dev]
+
+    - name: Cache dependencies
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Lint with Ruff
+      run: |
+        ruff check .
+        ruff format --check .
+
+    - name: Run tests with pytest
+      run: |
+        pytest tests/ --cov=pysgn --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

pysgn-0.1.0/.github/workflows/draft-pdf.yml

@@ -0,0 +1,28 @@
+name: draft-pdf
+on:
+  push:
+    paths:
+      - paper/**
+      - .github/workflows/draft-pdf.yml
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/paper.pdf

pysgn-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: release
+on:
+  push:
+    tags:
+    - "v*"
+    branches:
+    - main
+    - release**
+    paths-ignore:
+      - '**.md'
+      - '**.rst'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.rst'
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+
+jobs:
+  release:
+    name: Deploy release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -U pip build wheel setuptools
+      - name: Build distributions
+        run: python -m build
+      - name: Upload package as artifact to GitHub
+        if: github.repository == 'wang-boyu/pysgn' && startsWith(github.ref, 'refs/tags')
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/
+      - name: Publish package to PyPI
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

pysgn-0.1.0/.gitignore

@@ -0,0 +1,334 @@
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+
+[Dd]ebug/
+[Rr]elease/
+x64/
+build/
+[Bb]in/
+[Oo]bj/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.log
+*.scc
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+*.ncrunch*
+.*crunch*.local.xml
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.Publish.xml
+*.pubxml
+*.publishproj
+
+# Windows Azure Build Output
+csx
+*.build.csdef
+
+# Windows Store app package directory
+AppPackages/
+
+# Others
+sql/
+*.Cache
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.[Pp]ublish.xml
+*.pfx
+*.publishsettings
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+App_Data/*.mdf
+App_Data/*.ldf
+
+#############
+## Windows detritus
+#############
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Mac crap
+.DS_Store
+
+
+#############
+## Python
+#############
+
+*.py[cod]
+
+# Packages
+*.egg
+*.egg-info
+dist/
+build/
+eggs/
+
+# 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/
+*.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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/html/
+docs/jupyter_execute/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.virtual_documents
+
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/
+parts/
+var/
+sdist/
+develop-eggs/
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+.pytest_cache
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+#Visual studio code
+.vscode
+
+# Idea file
+.idea
+
+# Cursor file
+.cursorrules
+
+data/
+docs/cache/
+notebooks/
+references/

pysgn-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+ci:
+    autoupdate_schedule: 'monthly'
+    autofix_prs: true
+
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.7.2
+  hooks:
+    # Run the linter with fix argument.
+    - id: ruff
+      types_or: [ python, pyi, jupyter ]
+      args: [--fix]  # This will enable automatic fixing of lint issues where possible.
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi, jupyter ]
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.19.0
+  hooks:
+    - id: pyupgrade
+      args: [--py310-plus]
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0  # Use the ref you want to point at
+  hooks:
+    - id: trailing-whitespace
+    - id: check-toml
+    - id: check-yaml

pysgn-0.1.0/.readthedocs.yml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: latest
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pysgn-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,94 @@
+Contributing
+============
+
+As an open source project, PySGN welcomes contributions of many forms, and from beginners to experts. If you are curious or just want to see what is happening, we post our development session agendas and development session notes on [PySGN discussions].
+
+In no particular order, examples include:
+
+- Code patches
+- Bug reports and patch reviews
+- New features
+- Documentation improvements
+- Tutorials
+
+[PySGN discussions]: https://github.com/wang-boyu/pysgn/discussions
+[issue]: https://github.com/wang-boyu/pysgn/issues
+
+**To submit a contribution**
+
+- Create a ticket for the item that you are working on.
+- Fork the PySGN repository.
+- [Clone your repository] from GitHub to your machine.
+- Create a new branch in your fork: `git checkout -b BRANCH_NAME`
+- Run `git config pull.rebase true`. This prevents messy merge commits when updating your branch on top of PySGN main branch.
+- Install an editable version with developer requirements locally: `pip install -e ".[dev]"`
+- Edit the code. Save.
+- Git add the new files and files with changes: `git add FILE_NAME`
+- Git commit your changes with a meaningful message: `git commit -m "Fix issue X"`
+- If implementing a new feature, include some documentation in docs folder.
+- Make sure that your submission passes the [GH Actions build]. See "Testing and Standards below" to be able to run these locally.
+- Make sure that your code is formatted according to the [black] standard (you can do it via [pre-commit]).
+- Push your changes to your fork on Github: `git push origin NAME_OF_BRANCH`.
+- [Create a pull request].
+- Describe the change w/ ticket number(s) that the code fixes.
+
+[Clone your repository]: https://help.github.com/articles/cloning-a-repository/
+[GH Actions build]: https://github.com/wang-boyu/pysgn/actions/workflows/ci.yml
+[Create a pull request]: https://help.github.com/articles/creating-a-pull-request/
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+Testing and Code Standards
+--------------------------
+
+[![](https://codecov.io/gh/wang-boyu/pysgn/branch/main/graph/badge.svg)](https://codecov.io/gh/wang-boyu/pysgn) [![](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+As part of our contribution process, we practice continuous integration and use GH Actions to help enforce best practices.
+
+If you're changing previous PySGN features, please make sure of the following:
+
+- Your changes pass the current tests.
+- Your changes pass our style standards.
+- Your changes don't break the models or your changes include updated models.
+- Additional features or rewrites of current features are accompanied by tests.
+- New features are demonstrated in a model, so folks can understand more easily.
+
+We test by implementing simple models and through traditional unit tests in the tests/ folder. The following only covers unit tests coverage. Ensure that your test coverage has not gone down. If it has and you need help, we will offer advice on how to structure tests for the contribution.
+
+```bash
+pytest --cov=pysgn tests/
+```
+
+With respect to code standards, we follow [PEP8] and the [Google Style Guide]. We recommend to use [black] as an automated code formatter. You can automatically format your code using [pre-commit], which will prevent `git commit` of unstyled code and will automatically apply black style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:
+
+```bash
+pre-commit install
+```
+
+You should no longer have to worry about code formatting. If still in doubt you may run the following command. If the command generates errors, fix all errors that are returned.
+
+```bash
+pre-commit run --all-files
+```
+
+[PEP8]: https://www.python.org/dev/peps/pep-0008
+[Google Style Guide]: https://google.github.io/styleguide/pyguide.html
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+Licensing
+---------
+
+The license of this project is located in [LICENSE]. By submitting a contribution to this project, you are agreeing that your contribution will be released under the terms of this license.
+
+[LICENSE]: https://github.com/wang-boyu/pysgn/blob/main/LICENSE
+
+Special Thanks
+--------------
+
+A special thanks to the following projects who offered inspiration for this contributing file.
+
+- [Mesa](https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md)
+- [Django](https://github.com/django/django/blob/master/CONTRIBUTING.rst)
+- [18F's FOIA](https://github.com/18F/foia-hub/blob/master/CONTRIBUTING.md)
+- [18F's Midas](https://github.com/18F/midas/blob/devel/CONTRIBUTING.md)

pysgn-0.1.0/LICENSE

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