physdes-py 0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. physdes_py-0.1/.coveragerc +28 -0
  2. physdes_py-0.1/.flake8 +3 -0
  3. physdes_py-0.1/.github/workflows/jekyll-gh-pages.yml +51 -0
  4. physdes_py-0.1/.github/workflows/multi-platforms.yml +38 -0
  5. physdes_py-0.1/.github/workflows/python-app.yml +47 -0
  6. physdes_py-0.1/.github/workflows/python-publish.yml +70 -0
  7. physdes_py-0.1/.gitignore +178 -0
  8. physdes_py-0.1/.gitpod.Dockerfile +78 -0
  9. physdes_py-0.1/.gitpod.yml +15 -0
  10. physdes_py-0.1/.hadolint.yaml +4 -0
  11. physdes_py-0.1/.isort.cfg +3 -0
  12. physdes_py-0.1/.markdownlint.yaml +10 -0
  13. physdes_py-0.1/.pre-commit-config.yaml +53 -0
  14. physdes_py-0.1/.readthedocs.yml +32 -0
  15. physdes_py-0.1/.shellcheckrc +3 -0
  16. physdes_py-0.1/AUTHORS.rst +5 -0
  17. physdes_py-0.1/CHANGELOG.rst +10 -0
  18. physdes_py-0.1/LICENSE +21 -0
  19. physdes_py-0.1/LICENSE.txt +21 -0
  20. physdes_py-0.1/PKG-INFO +52 -0
  21. physdes_py-0.1/README.md +28 -0
  22. physdes_py-0.1/README.rst +39 -0
  23. physdes_py-0.1/_config.yml +1 -0
  24. physdes_py-0.1/diagram.bob +56 -0
  25. physdes_py-0.1/docs/Makefile +29 -0
  26. physdes_py-0.1/docs/_static/.gitignore +1 -0
  27. physdes_py-0.1/docs/authors.rst +2 -0
  28. physdes_py-0.1/docs/changelog.rst +2 -0
  29. physdes_py-0.1/docs/conf.py +284 -0
  30. physdes_py-0.1/docs/contributing.md +374 -0
  31. physdes_py-0.1/docs/index.rst +61 -0
  32. physdes_py-0.1/docs/license.rst +7 -0
  33. physdes_py-0.1/docs/readme.rst +2 -0
  34. physdes_py-0.1/docs/requirements.txt +6 -0
  35. physdes_py-0.1/environment.yml +8 -0
  36. physdes_py-0.1/mypy.ini +24 -0
  37. physdes_py-0.1/note.md +57 -0
  38. physdes_py-0.1/oryx-build-commands.txt +2 -0
  39. physdes_py-0.1/pyproject.toml +9 -0
  40. physdes_py-0.1/rectilinear-shapes-for-vlsi-physical-desgin.svg +335 -0
  41. physdes_py-0.1/requirements/README.md +27 -0
  42. physdes_py-0.1/requirements/default.txt +2 -0
  43. physdes_py-0.1/requirements/doc.txt +6 -0
  44. physdes_py-0.1/requirements/extras.txt +2 -0
  45. physdes_py-0.1/requirements/test.txt +6 -0
  46. physdes_py-0.1/requirements.txt +19 -0
  47. physdes_py-0.1/setup.cfg +76 -0
  48. physdes_py-0.1/setup.py +22 -0
  49. physdes_py-0.1/src/physdes/__init__.py +16 -0
  50. physdes_py-0.1/src/physdes/generic.py +273 -0
  51. physdes_py-0.1/src/physdes/generic.tpy +89 -0
  52. physdes_py-0.1/src/physdes/interval.py +637 -0
  53. physdes_py-0.1/src/physdes/merge_obj.py +274 -0
  54. physdes_py-0.1/src/physdes/point.py +483 -0
  55. physdes_py-0.1/src/physdes/point.tpy +138 -0
  56. physdes_py-0.1/src/physdes/polygon.py +538 -0
  57. physdes_py-0.1/src/physdes/recti.py +273 -0
  58. physdes_py-0.1/src/physdes/rpolygon.py +566 -0
  59. physdes_py-0.1/src/physdes/skeleton.py +149 -0
  60. physdes_py-0.1/src/physdes/vector2.py +386 -0
  61. physdes_py-0.1/src/physdes/vector2.tpy +66 -0
  62. physdes_py-0.1/src/physdes_py.egg-info/PKG-INFO +52 -0
  63. physdes_py-0.1/src/physdes_py.egg-info/SOURCES.txt +89 -0
  64. physdes_py-0.1/src/physdes_py.egg-info/dependency_links.txt +1 -0
  65. physdes_py-0.1/src/physdes_py.egg-info/not-zip-safe +1 -0
  66. physdes_py-0.1/src/physdes_py.egg-info/requires.txt +11 -0
  67. physdes_py-0.1/src/physdes_py.egg-info/top_level.txt +1 -0
  68. physdes_py-0.1/svgo.config.js +14 -0
  69. physdes_py-0.1/tests/conftest.py +10 -0
  70. physdes_py-0.1/tests/golden.txt +0 -0
  71. physdes_py-0.1/tests/mysvg.css +21 -0
  72. physdes_py-0.1/tests/pnrpoly.svg +59 -0
  73. physdes_py-0.1/tests/test_interval.py +239 -0
  74. physdes_py-0.1/tests/test_merge.py +38 -0
  75. physdes_py-0.1/tests/test_overlap.py +10 -0
  76. physdes_py-0.1/tests/test_point.py +62 -0
  77. physdes_py-0.1/tests/test_polygon.py +139 -0
  78. physdes_py-0.1/tests/test_polygon.svg +4 -0
  79. physdes_py-0.1/tests/test_rect3d.py +99 -0
  80. physdes_py-0.1/tests/test_recti.py +91 -0
  81. physdes_py-0.1/tests/test_rpolygon.py +115 -0
  82. physdes_py-0.1/tests/test_rpolygon.svg +4 -0
  83. physdes_py-0.1/tests/test_skeleton.py +25 -0
  84. physdes_py-0.1/tests/test_vector2.py +65 -0
  85. physdes_py-0.1/tests/travis_install.sh +60 -0
  86. physdes_py-0.1/tests/xmono_polygon.svg +55 -0
  87. physdes_py-0.1/tests/xmono_polygon2.svg +55 -0
  88. physdes_py-0.1/tests/ymono_polygon.svg +4 -0
  89. physdes_py-0.1/tests/ymono_rpolygon.svg +4 -0
  90. physdes_py-0.1/tox.ini +91 -0
@@ -0,0 +1,28 @@
1
+ # .coveragerc to control coverage.py
2
+ [run]
3
+ branch = True
4
+ source = physdes
5
+ # omit = bad_file.py
6
+
7
+ [paths]
8
+ source =
9
+ src/
10
+ */site-packages/
11
+
12
+ [report]
13
+ # Regexes for lines to exclude from consideration
14
+ exclude_lines =
15
+ # Have to re-enable the standard pragma
16
+ pragma: no cover
17
+
18
+ # Don't complain about missing debug-only code:
19
+ def __repr__
20
+ if self\.debug
21
+
22
+ # Don't complain if tests don't hit defensive assertion code:
23
+ raise AssertionError
24
+ raise NotImplementedError
25
+
26
+ # Don't complain if non-runnable code isn't run:
27
+ if 0:
28
+ if __name__ == .__main__.:
physdes_py-0.1/.flake8 ADDED
@@ -0,0 +1,3 @@
1
+ # Autoformatter friendly flake8 config (all formatting rules disabled)
2
+ [flake8]
3
+ extend-ignore = E1, E2, E3, E501, W1, W2, W3, W5
@@ -0,0 +1,51 @@
1
+ # Sample workflow for building and deploying a Jekyll site to GitHub Pages
2
+ name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3
+
4
+ on:
5
+ # Runs on pushes targeting the default branch
6
+ push:
7
+ branches: ["main"]
8
+
9
+ # Allows you to run this workflow manually from the Actions tab
10
+ workflow_dispatch:
11
+
12
+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13
+ permissions:
14
+ contents: read
15
+ pages: write
16
+ id-token: write
17
+
18
+ # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19
+ # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20
+ concurrency:
21
+ group: "pages"
22
+ cancel-in-progress: false
23
+
24
+ jobs:
25
+ # Build job
26
+ build:
27
+ runs-on: ubuntu-latest
28
+ steps:
29
+ - name: Checkout
30
+ uses: actions/checkout@v4
31
+ - name: Setup Pages
32
+ uses: actions/configure-pages@v4
33
+ - name: Build with Jekyll
34
+ uses: actions/jekyll-build-pages@v1
35
+ with:
36
+ source: ./
37
+ destination: ./_site
38
+ - name: Upload artifact
39
+ uses: actions/upload-pages-artifact@v3
40
+
41
+ # Deployment job
42
+ deploy:
43
+ environment:
44
+ name: github-pages
45
+ url: ${{ steps.deployment.outputs.page_url }}
46
+ runs-on: ubuntu-latest
47
+ needs: build
48
+ steps:
49
+ - name: Deploy to GitHub Pages
50
+ id: deployment
51
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,38 @@
1
+ name: Multi-Platforms
2
+ on: [push]
3
+
4
+ jobs:
5
+ miniconda:
6
+ name: Miniconda ${{ matrix.os }} for Python ${{ matrix.version }}
7
+ runs-on: ${{ matrix.os }}
8
+ strategy:
9
+ matrix:
10
+ os: ["ubuntu-latest", "windows-latest"]
11
+ version: ["3.10", "3.12"]
12
+ steps:
13
+ - uses: actions/checkout@v2
14
+ - uses: conda-incubator/setup-miniconda@v2
15
+ with:
16
+ activate-environment: test
17
+ environment-file: environment.yml
18
+ python-version: ${{ matrix.version }}
19
+ auto-activate-base: false
20
+ - shell: bash -l {0}
21
+ run: |
22
+ conda info
23
+ conda list
24
+ - name: Lint
25
+ shell: bash -l {0}
26
+ run: |
27
+ conda install flake8
28
+ python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
29
+ python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
30
+ - name: Run pytest
31
+ shell: bash -l {0}
32
+ run: |
33
+ conda install pytest
34
+ python -m pip install --upgrade pip
35
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
36
+ pip install git+https://github.com/luk036/lds-gen.git
37
+ python setup.py develop
38
+ pytest
@@ -0,0 +1,47 @@
1
+ # This workflow will install Python dependencies, run tests and lint with a single version of Python
2
+ # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3
+
4
+ name: Python application (new)
5
+
6
+ on:
7
+ push:
8
+ branches: [main]
9
+ pull_request:
10
+ branches: [main]
11
+
12
+ jobs:
13
+ build:
14
+ runs-on: ubuntu-latest
15
+
16
+ steps:
17
+ - uses: actions/checkout@v2
18
+ - name: Set up Python 3.10
19
+ uses: actions/setup-python@v2
20
+ with:
21
+ python-version: "3.10"
22
+ - name: Install dependencies
23
+ run: |
24
+ python -m pip install --upgrade pip
25
+ pip install flake8 pytest
26
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
27
+ pip install git+https://github.com/luk036/lds-gen.git
28
+ python setup.py develop
29
+
30
+ - name: Lint with flake8
31
+ run: |
32
+ # stop the build if there are Python syntax errors or undefined names
33
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
34
+ # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
35
+ flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
36
+ - name: Test with pytest
37
+ run: |
38
+ pytest --cov=src/
39
+ - name: Codecov
40
+ # You may pin to the exact commit or the version.
41
+ # uses: codecov/codecov-action@29386c70ef20e286228c72b668a06fd0e8399192
42
+ uses: codecov/codecov-action@v1.5.2
43
+ with:
44
+ # Repository upload token - get it from codecov.io. Required only for private repositories
45
+ token: ${{ secrets.CODECOV_TOKEN }}
46
+ # Comma-separated list of files to upload
47
+ fail_ci_if_error: true
@@ -0,0 +1,70 @@
1
+ # This workflow will upload a Python Package to PyPI when a release is created
2
+ # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
+
4
+ # This workflow uses actions that are not certified by GitHub.
5
+ # They are provided by a third-party and are governed by
6
+ # separate terms of service, privacy policy, and support
7
+ # documentation.
8
+
9
+ name: Upload Python Package
10
+
11
+ on:
12
+ release:
13
+ types: [published]
14
+
15
+ permissions:
16
+ contents: read
17
+
18
+ jobs:
19
+ release-build:
20
+ runs-on: ubuntu-latest
21
+
22
+ steps:
23
+ - uses: actions/checkout@v4
24
+
25
+ - uses: actions/setup-python@v5
26
+ with:
27
+ python-version: "3.x"
28
+
29
+ - name: Build release distributions
30
+ run: |
31
+ # NOTE: put your own distribution build steps here.
32
+ python -m pip install build
33
+ python -m build
34
+
35
+ - name: Upload distributions
36
+ uses: actions/upload-artifact@v4
37
+ with:
38
+ name: release-dists
39
+ path: dist/
40
+
41
+ pypi-publish:
42
+ runs-on: ubuntu-latest
43
+ needs:
44
+ - release-build
45
+ permissions:
46
+ # IMPORTANT: this permission is mandatory for trusted publishing
47
+ id-token: write
48
+
49
+ # Dedicated environments with protections for publishing are strongly recommended.
50
+ # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
51
+ environment:
52
+ name: pypi
53
+ # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
54
+ # url: https://pypi.org/p/YOURPROJECT
55
+ #
56
+ # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
57
+ # ALTERNATIVE: exactly, uncomment the following line instead:
58
+ # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
59
+
60
+ steps:
61
+ - name: Retrieve release distributions
62
+ uses: actions/download-artifact@v4
63
+ with:
64
+ name: release-dists
65
+ path: dist/
66
+
67
+ - name: Publish release distributions to PyPI
68
+ uses: pypa/gh-action-pypi-publish@release/v1
69
+ with:
70
+ packages-dir: dist/
@@ -0,0 +1,178 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/#use-with-ide
110
+ .pdm.toml
111
+
112
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
+ __pypackages__/
114
+
115
+ # Celery stuff
116
+ celerybeat-schedule
117
+ celerybeat.pid
118
+
119
+ # SageMath parsed files
120
+ *.sage.py
121
+
122
+ # Environments
123
+ .env
124
+ .venv
125
+ env/
126
+ venv/
127
+ ENV/
128
+ env.bak/
129
+ venv.bak/
130
+
131
+ # Spyder project settings
132
+ .spyderproject
133
+ .spyproject
134
+
135
+ # Rope project settings
136
+ .ropeproject
137
+
138
+ # mkdocs documentation
139
+ /site
140
+
141
+ # mypy
142
+ .mypy_cache/
143
+ .dmypy.json
144
+ dmypy.json
145
+
146
+ # Pyre type checker
147
+ .pyre/
148
+
149
+ # pytype static type analyzer
150
+ .pytype/
151
+
152
+ # Cython debug symbols
153
+ cython_debug/
154
+
155
+ # PyCharm
156
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
159
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160
+ #.idea/
161
+
162
+ # Build and docs folder/files
163
+ build/*
164
+ dist/*
165
+ sdist/*
166
+ docs/api/*
167
+ docs/_rst/*
168
+ docs/_build/*
169
+ cover/*
170
+ MANIFEST
171
+
172
+ # Per-project virtualenvs
173
+ .venv*/
174
+ .conda*/
175
+ .python-version
176
+
177
+ # my stuffs
178
+ .hypothesis
@@ -0,0 +1,78 @@
1
+ FROM gitpod/workspace-full
2
+
3
+ USER root
4
+ # Install util tools.
5
+
6
+ RUN apt-get update \
7
+ && apt-get install -y \
8
+ apt-utils \
9
+ aria2 \
10
+ # utilities (not ripgrep, gh) \
11
+ asciinema \
12
+ bat \
13
+ byobu \
14
+ curl \
15
+ elinks \
16
+ fd-find \
17
+ fish \
18
+ mdp \
19
+ ncdu \
20
+ neofetch \
21
+ patat \
22
+ pkg-config \
23
+ ranger \
24
+ w3m \
25
+ # just for fun (not cmatrix) \
26
+ cowsay \
27
+ figlet \
28
+ fortune \
29
+ toilet \
30
+ tty-clock
31
+
32
+ RUN mkdir -p /workspace/data \
33
+ && chown -R gitpod:gitpod /workspace/data
34
+
35
+ RUN mkdir /home/gitpod/.conda
36
+ # Install conda
37
+ RUN wget --quiet https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda.sh && \
38
+ /bin/bash ~/miniconda.sh -b -p /opt/conda && \
39
+ rm ~/miniconda.sh && \
40
+ ln -s /opt/conda/etc/profile.d/conda.sh /etc/profile.d/conda.sh && \
41
+ echo ". /opt/conda/etc/profile.d/conda.sh" >> ~/.bashrc && \
42
+ echo "conda activate base" >> ~/.bashrc
43
+
44
+ RUN /opt/conda/bin/conda config --set always_yes yes --set changeps1 no \
45
+ && /opt/conda/bin/conda update -q conda \
46
+ && /opt/conda/bin/conda info -a
47
+
48
+ RUN /opt/conda/bin/conda install -y -c conda-forge \
49
+ pandoc-crossref \
50
+ pandoc
51
+
52
+ # RUN /opt/conda/bin/pip install \
53
+ # codecov \
54
+ # coverage \
55
+ # coveralls \
56
+ # cvxpy \
57
+ # jupyter \
58
+ # matplotlib \
59
+ # networkx \
60
+ # numexpr \
61
+ # numpy \
62
+ # scipy \
63
+ # flake8 \
64
+ # mypy \
65
+ # pre-commit \
66
+ # pyqt5 \
67
+ # pytest-benchmark \
68
+ # pytest-cov \
69
+ # pytest \
70
+ # yapf \
71
+ # lolcat
72
+
73
+ RUN chown -R gitpod:gitpod /opt/conda \
74
+ && chmod -R 777 /opt/conda \
75
+ && chown -R gitpod:gitpod /home/gitpod/.conda \
76
+ && chmod -R 777 /home/gitpod/.conda
77
+
78
+ RUN apt-get clean && rm -rf /var/cache/apt/* && rm -rf /var/lib/apt/lists/* && rm -rf /tmp/*
@@ -0,0 +1,15 @@
1
+ ports:
2
+ - port: 8050
3
+ onOpen: open-preview
4
+ - port: 8888
5
+ onOpen: open-browser
6
+ tasks:
7
+ - command: >
8
+ pip3 install -r ./requirements.txt &&
9
+ python3 setup.py develop
10
+ # image:
11
+ # file: .gitpod.Dockerfile
12
+
13
+ vscode:
14
+ extensions:
15
+ - njpwerner.autodocstring
@@ -0,0 +1,4 @@
1
+ # Following source doesn't work in most setups
2
+ ignored:
3
+ - SC1090
4
+ - SC1091
@@ -0,0 +1,3 @@
1
+ [settings]
2
+ profile = black
3
+ known_first_party = physdes
@@ -0,0 +1,10 @@
1
+ # Autoformatter friendly markdownlint config (all formatting rules disabled)
2
+ default: true
3
+ blank_lines: false
4
+ bullet: false
5
+ html: false
6
+ indentation: false
7
+ line_length: false
8
+ spaces: false
9
+ url: false
10
+ whitespace: false
@@ -0,0 +1,53 @@
1
+ exclude: "^docs/conf.py"
2
+
3
+ repos:
4
+ - repo: https://github.com/pre-commit/pre-commit-hooks
5
+ rev: v4.4.0
6
+ hooks:
7
+ - id: trailing-whitespace
8
+ - id: check-added-large-files
9
+ - id: check-ast
10
+ - id: check-json
11
+ - id: check-merge-conflict
12
+ - id: check-xml
13
+ - id: check-yaml
14
+ - id: debug-statements
15
+ - id: end-of-file-fixer
16
+ - id: requirements-txt-fixer
17
+ - id: mixed-line-ending
18
+ args: ["--fix=auto"] # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
19
+
20
+ ## If you want to avoid flake8 errors due to unused vars or imports:
21
+ # - repo: https://github.com/myint/autoflake
22
+ # rev: v1.4
23
+ # hooks:
24
+ # - id: autoflake
25
+ # args: [
26
+ # --in-place,
27
+ # --remove-all-unused-imports,
28
+ # --remove-unused-variables,
29
+ # ]
30
+
31
+ - repo: https://github.com/pycqa/isort
32
+ rev: 5.12.0
33
+ hooks:
34
+ - id: isort
35
+
36
+ - repo: https://github.com/psf/black
37
+ rev: 23.7.0
38
+ hooks:
39
+ - id: black
40
+ language_version: python3
41
+
42
+ ## If like to embrace black styles even in the docs:
43
+ # - repo: https://github.com/asottile/blacken-docs
44
+ # rev: v1.12.0
45
+ # hooks:
46
+ # - id: blacken-docs
47
+ # additional_dependencies: [black]
48
+ - repo: https://github.com/PyCQA/flake8
49
+ rev: 6.1.0
50
+ hooks:
51
+ - id: flake8
52
+ ## You can add flake8 plugins via `additional_dependencies`:
53
+ # additional_dependencies: [flake8-bugbear]
@@ -0,0 +1,32 @@
1
+ # .readthedocs.yaml
2
+ # Read the Docs configuration file
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+ # Required
6
+ version: 2
7
+
8
+ # Set the OS, Python version and other tools you might need
9
+ build:
10
+ os: ubuntu-22.04
11
+ tools:
12
+ python: "3.11"
13
+ # You can also specify other tool versions:
14
+ # nodejs: "19"
15
+ # rust: "1.64"
16
+ # golang: "1.19"
17
+
18
+ # Build documentation in the "docs/" directory with Sphinx
19
+ sphinx:
20
+ configuration: docs/conf.py
21
+
22
+ # Optionally build your docs in additional formats such as PDF and ePub
23
+ formats:
24
+ - pdf
25
+
26
+ # Optional but recommended, declare the Python requirements required
27
+ # to build your documentation
28
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
29
+ python:
30
+ install:
31
+ - requirements: docs/requirements.txt
32
+ - { path: ., method: pip }
@@ -0,0 +1,3 @@
1
+ # Following source doesn't work in most setups
2
+ disable=SC1090
3
+ disable=SC1091
@@ -0,0 +1,5 @@
1
+ ============
2
+ Contributors
3
+ ============
4
+
5
+ * Wai-Shing Luk <luk036@gmail.com>
@@ -0,0 +1,10 @@
1
+ =========
2
+ Changelog
3
+ =========
4
+
5
+ Version 0.1
6
+ ===========
7
+
8
+ - Feature A added
9
+ - FIX: nasty bug #1729 fixed
10
+ - add your changes here!
physdes_py-0.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Wai-Shing Luk
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022 Wai-Shing Luk
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.