palvisualpy 0.1.0__tar.gz → 0.1.3__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.
@@ -1,10 +1,12 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.5
2
2
  Name: palvisualpy
3
- Version: 0.1.0
3
+ Version: 0.1.3
4
4
  Summary: A visual for py lib
5
5
  Author-email: Tiny Twist <tiny.mahua@gmail.com>
6
6
  Maintainer-email: Tiny Twist <tiny.mahua@gmail.com>
7
7
  Requires-Python: >= 3.6
8
+ License-File: AUTHORS.rst
8
9
  License-File: LICENSE.txt
9
10
  Requires-Dist: rich == 13.3.5
10
- Requires-Dist: flatdict == 4.0.1
11
+ Requires-Dist: flatdict == 4.1.0
12
+ Import-Name: palvisualpy
@@ -9,7 +9,7 @@ requires-python = ">= 3.6"
9
9
  name = "palvisualpy"
10
10
  dependencies = [
11
11
  "rich == 13.3.5",
12
- "flatdict == 4.0.1"
12
+ "flatdict == 4.1.0"
13
13
  ]
14
14
  authors = [
15
15
  {name = "Tiny Twist", email = "tiny.mahua@gmail.com"},
@@ -1,4 +1,4 @@
1
- __version__ = "0.1.0"
1
+ __version__ = "0.1.3"
2
2
 
3
3
 
4
4
  from rich.tree import Tree
@@ -1,28 +0,0 @@
1
- # .coveragerc to control coverage.py
2
- [run]
3
- branch = True
4
- source = palvisualpy
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__.:
@@ -1,54 +0,0 @@
1
- # Temporary and binary files
2
- *~
3
- *.py[cod]
4
- *.so
5
- *.cfg
6
- !.isort.cfg
7
- !setup.cfg
8
- *.orig
9
- *.log
10
- *.pot
11
- __pycache__/*
12
- .cache/*
13
- .*.swp
14
- */.ipynb_checkpoints/*
15
- .DS_Store
16
-
17
- # Project files
18
- .ropeproject
19
- .project
20
- .pydevproject
21
- .settings
22
- .idea
23
- .vscode
24
- tags
25
-
26
- # Package files
27
- *.egg
28
- *.eggs/
29
- .installed.cfg
30
- *.egg-info
31
-
32
- # Unittest and coverage
33
- htmlcov/*
34
- .coverage
35
- .coverage.*
36
- .tox
37
- junit*.xml
38
- coverage.xml
39
- .pytest_cache/
40
-
41
- # Build and docs folder/files
42
- build/*
43
- dist/*
44
- sdist/*
45
- docs/api/*
46
- docs/_rst/*
47
- docs/_build/*
48
- cover/*
49
- MANIFEST
50
-
51
- # Per-project virtualenvs
52
- .venv*/
53
- .conda*/
54
- .python-version
@@ -1,27 +0,0 @@
1
- # Read the Docs configuration file
2
- # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
-
4
- # Required
5
- version: 2
6
-
7
- # Build documentation in the docs/ directory with Sphinx
8
- sphinx:
9
- configuration: docs/conf.py
10
-
11
- # Build documentation with MkDocs
12
- #mkdocs:
13
- # configuration: mkdocs.yml
14
-
15
- # Optionally build your docs in additional formats such as PDF
16
- formats:
17
- - pdf
18
-
19
- build:
20
- os: ubuntu-22.04
21
- tools:
22
- python: "3.11"
23
-
24
- python:
25
- install:
26
- - requirements: docs/requirements.txt
27
- - {path: ., method: pip}
@@ -1,10 +0,0 @@
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!
@@ -1,353 +0,0 @@
1
- .. todo:: THIS IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!
2
-
3
- The document assumes you are using a source repository service that promotes a
4
- contribution model similar to `GitHub's fork and pull request workflow`_.
5
- While this is true for the majority of services (like GitHub, GitLab,
6
- BitBucket), it might not be the case for private repositories (e.g., when
7
- using Gerrit).
8
-
9
- Also notice that the code examples might refer to GitHub URLs or the text
10
- might use GitHub specific terminology (e.g., *Pull Request* instead of *Merge
11
- Request*).
12
-
13
- Please make sure to check the document having these assumptions in mind
14
- and update things accordingly.
15
-
16
- .. todo:: Provide the correct links/replacements at the bottom of the document.
17
-
18
- .. todo:: You might want to have a look on `PyScaffold's contributor's guide`_,
19
-
20
- especially if your project is open source. The text should be very similar to
21
- this template, but there are a few extra contents that you might decide to
22
- also include, like mentioning labels of your issue tracker or automated
23
- releases.
24
-
25
-
26
- ============
27
- Contributing
28
- ============
29
-
30
- Welcome to ``palvisualpy`` contributor's guide.
31
-
32
- This document focuses on getting any potential contributor familiarized
33
- with the development processes, but `other kinds of contributions`_ are also
34
- appreciated.
35
-
36
- If you are new to using git_ or have never collaborated in a project previously,
37
- please have a look at `contribution-guide.org`_. Other resources are also
38
- listed in the excellent `guide created by FreeCodeCamp`_ [#contrib1]_.
39
-
40
- Please notice, all users and contributors are expected to be **open,
41
- considerate, reasonable, and respectful**. When in doubt, `Python Software
42
- Foundation's Code of Conduct`_ is a good reference in terms of behavior
43
- guidelines.
44
-
45
-
46
- Issue Reports
47
- =============
48
-
49
- If you experience bugs or general issues with ``palvisualpy``, please have a look
50
- on the `issue tracker`_. If you don't see anything useful there, please feel
51
- free to fire an issue report.
52
-
53
- .. tip::
54
- Please don't forget to include the closed issues in your search.
55
- Sometimes a solution was already reported, and the problem is considered
56
- **solved**.
57
-
58
- New issue reports should include information about your programming environment
59
- (e.g., operating system, Python version) and steps to reproduce the problem.
60
- Please try also to simplify the reproduction steps to a very minimal example
61
- that still illustrates the problem you are facing. By removing other factors,
62
- you help us to identify the root cause of the issue.
63
-
64
-
65
- Documentation Improvements
66
- ==========================
67
-
68
- You can help improve ``palvisualpy`` docs by making them more readable and coherent, or
69
- by adding missing information and correcting mistakes.
70
-
71
- ``palvisualpy`` documentation uses Sphinx_ as its main documentation compiler.
72
- This means that the docs are kept in the same repository as the project code, and
73
- that any documentation update is done in the same way was a code contribution.
74
-
75
- .. todo:: Don't forget to mention which markup language you are using.
76
-
77
- e.g., reStructuredText_ or CommonMark_ with MyST_ extensions.
78
-
79
- .. todo:: If your project is hosted on GitHub, you can also mention the following tip:
80
-
81
- .. tip::
82
- Please notice that the `GitHub web interface`_ provides a quick way of
83
- propose changes in ``palvisualpy``'s files. While this mechanism can
84
- be tricky for normal code contributions, it works perfectly fine for
85
- contributing to the docs, and can be quite handy.
86
-
87
- If you are interested in trying this method out, please navigate to
88
- the ``docs`` folder in the source repository_, find which file you
89
- would like to propose changes and click in the little pencil icon at the
90
- top, to open `GitHub's code editor`_. Once you finish editing the file,
91
- please write a message in the form at the bottom of the page describing
92
- which changes have you made and what are the motivations behind them and
93
- submit your proposal.
94
-
95
- When working on documentation changes in your local machine, you can
96
- compile them using |tox|_::
97
-
98
- tox -e docs
99
-
100
- and use Python's built-in web server for a preview in your web browser
101
- (``http://localhost:8000``)::
102
-
103
- python3 -m http.server --directory 'docs/_build/html'
104
-
105
-
106
- Code Contributions
107
- ==================
108
-
109
- .. todo:: Please include a reference or explanation about the internals of the project.
110
-
111
- An architecture description, design principles or at least a summary of the
112
- main concepts will make it easy for potential contributors to get started
113
- quickly.
114
-
115
- Submit an issue
116
- ---------------
117
-
118
- Before you work on any non-trivial code contribution it's best to first create
119
- a report in the `issue tracker`_ to start a discussion on the subject.
120
- This often provides additional considerations and avoids unnecessary work.
121
-
122
- Create an environment
123
- ---------------------
124
-
125
- Before you start coding, we recommend creating an isolated `virtual
126
- environment`_ to avoid any problems with your installed Python packages.
127
- This can easily be done via either |virtualenv|_::
128
-
129
- virtualenv <PATH TO VENV>
130
- source <PATH TO VENV>/bin/activate
131
-
132
- or Miniconda_::
133
-
134
- conda create -n palvisualpy python=3 six virtualenv pytest pytest-cov
135
- conda activate palvisualpy
136
-
137
- Clone the repository
138
- --------------------
139
-
140
- #. Create an user account on |the repository service| if you do not already have one.
141
- #. Fork the project repository_: click on the *Fork* button near the top of the
142
- page. This creates a copy of the code under your account on |the repository service|.
143
- #. Clone this copy to your local disk::
144
-
145
- git clone git@github.com:YourLogin/palvisualpy.git
146
- cd palvisualpy
147
-
148
- #. You should run::
149
-
150
- pip install -U pip setuptools -e .
151
-
152
- to be able to import the package under development in the Python REPL.
153
-
154
- .. todo:: if you are not using pre-commit, please remove the following item:
155
-
156
- #. Install |pre-commit|_::
157
-
158
- pip install pre-commit
159
- pre-commit install
160
-
161
- ``palvisualpy`` comes with a lot of hooks configured to automatically help the
162
- developer to check the code being written.
163
-
164
- Implement your changes
165
- ----------------------
166
-
167
- #. Create a branch to hold your changes::
168
-
169
- git checkout -b my-feature
170
-
171
- and start making changes. Never work on the main branch!
172
-
173
- #. Start your work on this branch. Don't forget to add docstrings_ to new
174
- functions, modules and classes, especially if they are part of public APIs.
175
-
176
- #. Add yourself to the list of contributors in ``AUTHORS.rst``.
177
-
178
- #. When you’re done editing, do::
179
-
180
- git add <MODIFIED FILES>
181
- git commit
182
-
183
- to record your changes in git_.
184
-
185
- .. todo:: if you are not using pre-commit, please remove the following item:
186
-
187
- Please make sure to see the validation messages from |pre-commit|_ and fix
188
- any eventual issues.
189
- This should automatically use flake8_/black_ to check/fix the code style
190
- in a way that is compatible with the project.
191
-
192
- .. important:: Don't forget to add unit tests and documentation in case your
193
- contribution adds an additional feature and is not just a bugfix.
194
-
195
- Moreover, writing a `descriptive commit message`_ is highly recommended.
196
- In case of doubt, you can check the commit history with::
197
-
198
- git log --graph --decorate --pretty=oneline --abbrev-commit --all
199
-
200
- to look for recurring communication patterns.
201
-
202
- #. Please check that your changes don't break any unit tests with::
203
-
204
- tox
205
-
206
- (after having installed |tox|_ with ``pip install tox`` or ``pipx``).
207
-
208
- You can also use |tox|_ to run several other pre-configured tasks in the
209
- repository. Try ``tox -av`` to see a list of the available checks.
210
-
211
- Submit your contribution
212
- ------------------------
213
-
214
- #. If everything works fine, push your local branch to |the repository service| with::
215
-
216
- git push -u origin my-feature
217
-
218
- #. Go to the web page of your fork and click |contribute button|
219
- to send your changes for review.
220
-
221
- .. todo:: if you are using GitHub, you can uncomment the following paragraph
222
-
223
- Find more detailed information in `creating a PR`_. You might also want to open
224
- the PR as a draft first and mark it as ready for review after the feedbacks
225
- from the continuous integration (CI) system or any required fixes.
226
-
227
-
228
- Troubleshooting
229
- ---------------
230
-
231
- The following tips can be used when facing problems to build or test the
232
- package:
233
-
234
- #. Make sure to fetch all the tags from the upstream repository_.
235
- The command ``git describe --abbrev=0 --tags`` should return the version you
236
- are expecting. If you are trying to run CI scripts in a fork repository,
237
- make sure to push all the tags.
238
- You can also try to remove all the egg files or the complete egg folder, i.e.,
239
- ``.eggs``, as well as the ``*.egg-info`` folders in the ``src`` folder or
240
- potentially in the root of your project.
241
-
242
- #. Sometimes |tox|_ misses out when new dependencies are added, especially to
243
- ``setup.cfg`` and ``docs/requirements.txt``. If you find any problems with
244
- missing dependencies when running a command with |tox|_, try to recreate the
245
- ``tox`` environment using the ``-r`` flag. For example, instead of::
246
-
247
- tox -e docs
248
-
249
- Try running::
250
-
251
- tox -r -e docs
252
-
253
- #. Make sure to have a reliable |tox|_ installation that uses the correct
254
- Python version (e.g., 3.7+). When in doubt you can run::
255
-
256
- tox --version
257
- # OR
258
- which tox
259
-
260
- If you have trouble and are seeing weird errors upon running |tox|_, you can
261
- also try to create a dedicated `virtual environment`_ with a |tox|_ binary
262
- freshly installed. For example::
263
-
264
- virtualenv .venv
265
- source .venv/bin/activate
266
- .venv/bin/pip install tox
267
- .venv/bin/tox -e all
268
-
269
- #. `Pytest can drop you`_ in an interactive session in the case an error occurs.
270
- In order to do that you need to pass a ``--pdb`` option (for example by
271
- running ``tox -- -k <NAME OF THE FALLING TEST> --pdb``).
272
- You can also setup breakpoints manually instead of using the ``--pdb`` option.
273
-
274
-
275
- Maintainer tasks
276
- ================
277
-
278
- Releases
279
- --------
280
-
281
- .. todo:: This section assumes you are using PyPI to publicly release your package.
282
-
283
- If instead you are using a different/private package index, please update
284
- the instructions accordingly.
285
-
286
- If you are part of the group of maintainers and have correct user permissions
287
- on PyPI_, the following steps can be used to release a new version for
288
- ``palvisualpy``:
289
-
290
- #. Make sure all unit tests are successful.
291
- #. Tag the current commit on the main branch with a release tag, e.g., ``v1.2.3``.
292
- #. Push the new tag to the upstream repository_, e.g., ``git push upstream v1.2.3``
293
- #. Clean up the ``dist`` and ``build`` folders with ``tox -e clean``
294
- (or ``rm -rf dist build``)
295
- to avoid confusion with old builds and Sphinx docs.
296
- #. Run ``tox -e build`` and check that the files in ``dist`` have
297
- the correct version (no ``.dirty`` or git_ hash) according to the git_ tag.
298
- Also check the sizes of the distributions, if they are too big (e.g., >
299
- 500KB), unwanted clutter may have been accidentally included.
300
- #. Run ``tox -e publish -- --repository pypi`` and check that everything was
301
- uploaded to PyPI_ correctly.
302
-
303
-
304
-
305
- .. [#contrib1] Even though, these resources focus on open source projects and
306
- communities, the general ideas behind collaborating with other developers
307
- to collectively create software are general and can be applied to all sorts
308
- of environments, including private companies and proprietary code bases.
309
-
310
-
311
- .. <-- start -->
312
- .. todo:: Please review and change the following definitions:
313
-
314
- .. |the repository service| replace:: GitHub
315
- .. |contribute button| replace:: "Create pull request"
316
-
317
- .. _repository: https://github.com/<USERNAME>/palvisualpy
318
- .. _issue tracker: https://github.com/<USERNAME>/palvisualpy/issues
319
- .. <-- end -->
320
-
321
-
322
- .. |virtualenv| replace:: ``virtualenv``
323
- .. |pre-commit| replace:: ``pre-commit``
324
- .. |tox| replace:: ``tox``
325
-
326
-
327
- .. _black: https://pypi.org/project/black/
328
- .. _CommonMark: https://commonmark.org/
329
- .. _contribution-guide.org: https://www.contribution-guide.org/
330
- .. _creating a PR: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
331
- .. _descriptive commit message: https://chris.beams.io/posts/git-commit
332
- .. _docstrings: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
333
- .. _first-contributions tutorial: https://github.com/firstcontributions/first-contributions
334
- .. _flake8: https://flake8.pycqa.org/en/stable/
335
- .. _git: https://git-scm.com
336
- .. _GitHub's fork and pull request workflow: https://guides.github.com/activities/forking/
337
- .. _guide created by FreeCodeCamp: https://github.com/FreeCodeCamp/how-to-contribute-to-open-source
338
- .. _Miniconda: https://docs.conda.io/en/latest/miniconda.html
339
- .. _MyST: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html
340
- .. _other kinds of contributions: https://opensource.guide/how-to-contribute
341
- .. _pre-commit: https://pre-commit.com/
342
- .. _PyPI: https://pypi.org/
343
- .. _PyScaffold's contributor's guide: https://pyscaffold.org/en/stable/contributing.html
344
- .. _Pytest can drop you: https://docs.pytest.org/en/stable/how-to/failures.html#using-python-library-pdb-with-pytest
345
- .. _Python Software Foundation's Code of Conduct: https://www.python.org/psf/conduct/
346
- .. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/
347
- .. _Sphinx: https://www.sphinx-doc.org/en/master/
348
- .. _tox: https://tox.wiki/en/stable/
349
- .. _virtual environment: https://realpython.com/python-virtual-environments-a-primer/
350
- .. _virtualenv: https://virtualenv.pypa.io/en/stable/
351
-
352
- .. _GitHub web interface: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
353
- .. _GitHub's code editor: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
@@ -1,49 +0,0 @@
1
- .. These are examples of badges you might want to add to your README:
2
- please update the URLs accordingly
3
-
4
- .. image:: https://api.cirrus-ci.com/github/<USER>/palvisualpy.svg?branch=main
5
- :alt: Built Status
6
- :target: https://cirrus-ci.com/github/<USER>/palvisualpy
7
- .. image:: https://readthedocs.org/projects/palvisualpy/badge/?version=latest
8
- :alt: ReadTheDocs
9
- :target: https://palvisualpy.readthedocs.io/en/stable/
10
- .. image:: https://img.shields.io/coveralls/github/<USER>/palvisualpy/main.svg
11
- :alt: Coveralls
12
- :target: https://coveralls.io/r/<USER>/palvisualpy
13
- .. image:: https://img.shields.io/pypi/v/palvisualpy.svg
14
- :alt: PyPI-Server
15
- :target: https://pypi.org/project/palvisualpy/
16
- .. image:: https://img.shields.io/conda/vn/conda-forge/palvisualpy.svg
17
- :alt: Conda-Forge
18
- :target: https://anaconda.org/conda-forge/palvisualpy
19
- .. image:: https://pepy.tech/badge/palvisualpy/month
20
- :alt: Monthly Downloads
21
- :target: https://pepy.tech/project/palvisualpy
22
- .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
23
- :alt: Twitter
24
- :target: https://twitter.com/palvisualpy
25
-
26
- .. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
27
- :alt: Project generated with PyScaffold
28
- :target: https://pyscaffold.org/
29
-
30
- |
31
-
32
- ===========
33
- palvisualpy
34
- ===========
35
-
36
-
37
- palvisualpy
38
-
39
-
40
- A longer description of your project goes here...
41
-
42
-
43
- .. _pyscaffold-notes:
44
-
45
- Note
46
- ====
47
-
48
- This project has been set up using PyScaffold 4.4. For details and usage
49
- information on PyScaffold see https://pyscaffold.org/.
File without changes
@@ -1,25 +0,0 @@
1
- from rich.table import Table
2
- from rich.console import Console
3
- import flatdict
4
-
5
- console = Console()
6
-
7
-
8
- def dict_to_rich_table(data: dict, table: Table=None):
9
- if table is None:
10
- table = Table('Dict View By Rich Table', show_lines=True)
11
-
12
- flatted_dict = flatdict.FlatDict(data)
13
- for k, v in flatted_dict.items():
14
- if isinstance(v, dict):
15
- sub_table = Table(show_lines=True)
16
- table.add_row(k, dict_to_rich_table(v, sub_table))
17
- elif isinstance(v, list):
18
- for e in v:
19
- sub_table = Table(show_lines=True)
20
- table.add_row(k, dict_to_rich_table(e, sub_table))
21
- else:
22
- table.add_row(k, f'{v}')
23
-
24
- return table
25
-
@@ -1,29 +0,0 @@
1
- # Makefile for Sphinx documentation
2
- #
3
-
4
- # You can set these variables from the command line, and also
5
- # from the environment for the first two.
6
- SPHINXOPTS ?=
7
- SPHINXBUILD ?= sphinx-build
8
- SOURCEDIR = .
9
- BUILDDIR = _build
10
- AUTODOCDIR = api
11
-
12
- # User-friendly check for sphinx-build
13
- ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
14
- $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/")
15
- endif
16
-
17
- .PHONY: help clean Makefile
18
-
19
- # Put it first so that "make" without argument is like "make help".
20
- help:
21
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22
-
23
- clean:
24
- rm -rf $(BUILDDIR)/* $(AUTODOCDIR)
25
-
26
- # Catch-all target: route all unknown targets to Sphinx using the new
27
- # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
28
- %: Makefile
29
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -1 +0,0 @@
1
- # Empty directory
@@ -1,2 +0,0 @@
1
- .. _authors:
2
- .. include:: ../AUTHORS.rst
@@ -1,2 +0,0 @@
1
- .. _changes:
2
- .. include:: ../CHANGELOG.rst
@@ -1,286 +0,0 @@
1
- # This file is execfile()d with the current directory set to its containing dir.
2
- #
3
- # This file only contains a selection of the most common options. For a full
4
- # list see the documentation:
5
- # https://www.sphinx-doc.org/en/master/usage/configuration.html
6
- #
7
- # All configuration values have a default; values that are commented out
8
- # serve to show the default.
9
-
10
- import os
11
- import sys
12
- import shutil
13
-
14
- # -- Path setup --------------------------------------------------------------
15
-
16
- __location__ = os.path.dirname(__file__)
17
-
18
- # If extensions (or modules to document with autodoc) are in another directory,
19
- # add these directories to sys.path here. If the directory is relative to the
20
- # documentation root, use os.path.abspath to make it absolute, like shown here.
21
- sys.path.insert(0, os.path.join(__location__, "../src"))
22
-
23
- # -- Run sphinx-apidoc -------------------------------------------------------
24
- # This hack is necessary since RTD does not issue `sphinx-apidoc` before running
25
- # `sphinx-build -b html . _build/html`. See Issue:
26
- # https://github.com/readthedocs/readthedocs.org/issues/1139
27
- # DON'T FORGET: Check the box "Install your project inside a virtualenv using
28
- # setup.py install" in the RTD Advanced Settings.
29
- # Additionally it helps us to avoid running apidoc manually
30
-
31
- try: # for Sphinx >= 1.7
32
- from sphinx.ext import apidoc
33
- except ImportError:
34
- from sphinx import apidoc
35
-
36
- output_dir = os.path.join(__location__, "api")
37
- module_dir = os.path.join(__location__, "../src/palvisualpy")
38
- try:
39
- shutil.rmtree(output_dir)
40
- except FileNotFoundError:
41
- pass
42
-
43
- try:
44
- import sphinx
45
-
46
- cmd_line = f"sphinx-apidoc --implicit-namespaces -f -o {output_dir} {module_dir}"
47
-
48
- args = cmd_line.split(" ")
49
- if tuple(sphinx.__version__.split(".")) >= ("1", "7"):
50
- # This is a rudimentary parse_version to avoid external dependencies
51
- args = args[1:]
52
-
53
- apidoc.main(args)
54
- except Exception as e:
55
- print("Running `sphinx-apidoc` failed!\n{}".format(e))
56
-
57
- # -- General configuration ---------------------------------------------------
58
-
59
- # If your documentation needs a minimal Sphinx version, state it here.
60
- # needs_sphinx = '1.0'
61
-
62
- # Add any Sphinx extension module names here, as strings. They can be extensions
63
- # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
64
- extensions = [
65
- "sphinx.ext.autodoc",
66
- "sphinx.ext.intersphinx",
67
- "sphinx.ext.todo",
68
- "sphinx.ext.autosummary",
69
- "sphinx.ext.viewcode",
70
- "sphinx.ext.coverage",
71
- "sphinx.ext.doctest",
72
- "sphinx.ext.ifconfig",
73
- "sphinx.ext.mathjax",
74
- "sphinx.ext.napoleon",
75
- ]
76
-
77
- # Add any paths that contain templates here, relative to this directory.
78
- templates_path = ["_templates"]
79
-
80
- # The suffix of source filenames.
81
- source_suffix = ".rst"
82
-
83
- # The encoding of source files.
84
- # source_encoding = 'utf-8-sig'
85
-
86
- # The master toctree document.
87
- master_doc = "index"
88
-
89
- # General information about the project.
90
- project = "palvisualpy"
91
- copyright = "2023, Tiny Twist"
92
-
93
- # The version info for the project you're documenting, acts as replacement for
94
- # |version| and |release|, also used in various other places throughout the
95
- # built documents.
96
- #
97
- # version: The short X.Y version.
98
- # release: The full version, including alpha/beta/rc tags.
99
- # If you don’t need the separation provided between version and release,
100
- # just set them both to the same value.
101
- try:
102
- from palvisualpy import __version__ as version
103
- except ImportError:
104
- version = ""
105
-
106
- if not version or version.lower() == "unknown":
107
- version = os.getenv("READTHEDOCS_VERSION", "unknown") # automatically set by RTD
108
-
109
- release = version
110
-
111
- # The language for content autogenerated by Sphinx. Refer to documentation
112
- # for a list of supported languages.
113
- # language = None
114
-
115
- # There are two options for replacing |today|: either, you set today to some
116
- # non-false value, then it is used:
117
- # today = ''
118
- # Else, today_fmt is used as the format for a strftime call.
119
- # today_fmt = '%B %d, %Y'
120
-
121
- # List of patterns, relative to source directory, that match files and
122
- # directories to ignore when looking for source files.
123
- exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"]
124
-
125
- # The reST default role (used for this markup: `text`) to use for all documents.
126
- # default_role = None
127
-
128
- # If true, '()' will be appended to :func: etc. cross-reference text.
129
- # add_function_parentheses = True
130
-
131
- # If true, the current module name will be prepended to all description
132
- # unit titles (such as .. function::).
133
- # add_module_names = True
134
-
135
- # If true, sectionauthor and moduleauthor directives will be shown in the
136
- # output. They are ignored by default.
137
- # show_authors = False
138
-
139
- # The name of the Pygments (syntax highlighting) style to use.
140
- pygments_style = "sphinx"
141
-
142
- # A list of ignored prefixes for module index sorting.
143
- # modindex_common_prefix = []
144
-
145
- # If true, keep warnings as "system message" paragraphs in the built documents.
146
- # keep_warnings = False
147
-
148
- # If this is True, todo emits a warning for each TODO entries. The default is False.
149
- todo_emit_warnings = True
150
-
151
-
152
- # -- Options for HTML output -------------------------------------------------
153
-
154
- # The theme to use for HTML and HTML Help pages. See the documentation for
155
- # a list of builtin themes.
156
- html_theme = "alabaster"
157
-
158
- # Theme options are theme-specific and customize the look and feel of a theme
159
- # further. For a list of options available for each theme, see the
160
- # documentation.
161
- html_theme_options = {
162
- "sidebar_width": "300px",
163
- "page_width": "1200px"
164
- }
165
-
166
- # Add any paths that contain custom themes here, relative to this directory.
167
- # html_theme_path = []
168
-
169
- # The name for this set of Sphinx documents. If None, it defaults to
170
- # "<project> v<release> documentation".
171
- # html_title = None
172
-
173
- # A shorter title for the navigation bar. Default is the same as html_title.
174
- # html_short_title = None
175
-
176
- # The name of an image file (relative to this directory) to place at the top
177
- # of the sidebar.
178
- # html_logo = ""
179
-
180
- # The name of an image file (within the static path) to use as favicon of the
181
- # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
182
- # pixels large.
183
- # html_favicon = None
184
-
185
- # Add any paths that contain custom static files (such as style sheets) here,
186
- # relative to this directory. They are copied after the builtin static files,
187
- # so a file named "default.css" will overwrite the builtin "default.css".
188
- html_static_path = ["_static"]
189
-
190
- # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
191
- # using the given strftime format.
192
- # html_last_updated_fmt = '%b %d, %Y'
193
-
194
- # If true, SmartyPants will be used to convert quotes and dashes to
195
- # typographically correct entities.
196
- # html_use_smartypants = True
197
-
198
- # Custom sidebar templates, maps document names to template names.
199
- # html_sidebars = {}
200
-
201
- # Additional templates that should be rendered to pages, maps page names to
202
- # template names.
203
- # html_additional_pages = {}
204
-
205
- # If false, no module index is generated.
206
- # html_domain_indices = True
207
-
208
- # If false, no index is generated.
209
- # html_use_index = True
210
-
211
- # If true, the index is split into individual pages for each letter.
212
- # html_split_index = False
213
-
214
- # If true, links to the reST sources are added to the pages.
215
- # html_show_sourcelink = True
216
-
217
- # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
218
- # html_show_sphinx = True
219
-
220
- # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
221
- # html_show_copyright = True
222
-
223
- # If true, an OpenSearch description file will be output, and all pages will
224
- # contain a <link> tag referring to it. The value of this option must be the
225
- # base URL from which the finished HTML is served.
226
- # html_use_opensearch = ''
227
-
228
- # This is the file name suffix for HTML files (e.g. ".xhtml").
229
- # html_file_suffix = None
230
-
231
- # Output file base name for HTML help builder.
232
- htmlhelp_basename = "palvisualpy-doc"
233
-
234
-
235
- # -- Options for LaTeX output ------------------------------------------------
236
-
237
- latex_elements = {
238
- # The paper size ("letterpaper" or "a4paper").
239
- # "papersize": "letterpaper",
240
- # The font size ("10pt", "11pt" or "12pt").
241
- # "pointsize": "10pt",
242
- # Additional stuff for the LaTeX preamble.
243
- # "preamble": "",
244
- }
245
-
246
- # Grouping the document tree into LaTeX files. List of tuples
247
- # (source start file, target name, title, author, documentclass [howto/manual]).
248
- latex_documents = [
249
- ("index", "user_guide.tex", "palvisualpy Documentation", "Tiny Twist", "manual")
250
- ]
251
-
252
- # The name of an image file (relative to this directory) to place at the top of
253
- # the title page.
254
- # latex_logo = ""
255
-
256
- # For "manual" documents, if this is true, then toplevel headings are parts,
257
- # not chapters.
258
- # latex_use_parts = False
259
-
260
- # If true, show page references after internal links.
261
- # latex_show_pagerefs = False
262
-
263
- # If true, show URL addresses after external links.
264
- # latex_show_urls = False
265
-
266
- # Documents to append as an appendix to all manuals.
267
- # latex_appendices = []
268
-
269
- # If false, no module index is generated.
270
- # latex_domain_indices = True
271
-
272
- # -- External mapping --------------------------------------------------------
273
- python_version = ".".join(map(str, sys.version_info[0:2]))
274
- intersphinx_mapping = {
275
- "sphinx": ("https://www.sphinx-doc.org/en/master", None),
276
- "python": ("https://docs.python.org/" + python_version, None),
277
- "matplotlib": ("https://matplotlib.org", None),
278
- "numpy": ("https://numpy.org/doc/stable", None),
279
- "sklearn": ("https://scikit-learn.org/stable", None),
280
- "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
281
- "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
282
- "setuptools": ("https://setuptools.pypa.io/en/stable/", None),
283
- "pyscaffold": ("https://pyscaffold.org/en/stable", None),
284
- }
285
-
286
- print(f"loading configurations for {project} {version} ...", file=sys.stderr)
@@ -1 +0,0 @@
1
- .. include:: ../CONTRIBUTING.rst
@@ -1,61 +0,0 @@
1
- ===========
2
- palvisualpy
3
- ===========
4
-
5
- This is the documentation of **palvisualpy**.
6
-
7
- .. note::
8
-
9
- This is the main page of your project's `Sphinx`_ documentation.
10
- It is formatted in `reStructuredText`_. Add additional pages
11
- by creating rst-files in ``docs`` and adding them to the `toctree`_ below.
12
- Use then `references`_ in order to link them from this page, e.g.
13
- :ref:`authors` and :ref:`changes`.
14
-
15
- It is also possible to refer to the documentation of other Python packages
16
- with the `Python domain syntax`_. By default you can reference the
17
- documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_,
18
- `Pandas`_, `Scikit-Learn`_. You can add more by extending the
19
- ``intersphinx_mapping`` in your Sphinx's ``conf.py``.
20
-
21
- The pretty useful extension `autodoc`_ is activated by default and lets
22
- you include documentation from docstrings. Docstrings can be written in
23
- `Google style`_ (recommended!), `NumPy style`_ and `classical style`_.
24
-
25
-
26
- Contents
27
- ========
28
-
29
- .. toctree::
30
- :maxdepth: 2
31
-
32
- Overview <readme>
33
- Contributions & Help <contributing>
34
- License <license>
35
- Authors <authors>
36
- Changelog <changelog>
37
- Module Reference <api/modules>
38
-
39
-
40
- Indices and tables
41
- ==================
42
-
43
- * :ref:`genindex`
44
- * :ref:`modindex`
45
- * :ref:`search`
46
-
47
- .. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
48
- .. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
49
- .. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
50
- .. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
51
- .. _Sphinx: https://www.sphinx-doc.org/
52
- .. _Python: https://docs.python.org/
53
- .. _Numpy: https://numpy.org/doc/stable
54
- .. _SciPy: https://docs.scipy.org/doc/scipy/reference/
55
- .. _matplotlib: https://matplotlib.org/contents.html#
56
- .. _Pandas: https://pandas.pydata.org/pandas-docs/stable
57
- .. _Scikit-Learn: https://scikit-learn.org/stable
58
- .. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
59
- .. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
60
- .. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
61
- .. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists
@@ -1,7 +0,0 @@
1
- .. _license:
2
-
3
- =======
4
- License
5
- =======
6
-
7
- .. include:: ../LICENSE.txt
@@ -1,2 +0,0 @@
1
- .. _readme:
2
- .. include:: ../README.rst
@@ -1,5 +0,0 @@
1
- # Requirements file for ReadTheDocs, check .readthedocs.yml.
2
- # To build the module reference correctly, make sure every external package
3
- # under `install_requires` in `setup.cfg` is also listed here!
4
- sphinx>=3.2.1
5
- # sphinx_rtd_theme
@@ -1,126 +0,0 @@
1
- # This file is used to configure your project.
2
- # Read more about the various options under:
3
- # https://setuptools.pypa.io/en/latest/userguide/declarative_config.html
4
- # https://setuptools.pypa.io/en/latest/references/keywords.html
5
-
6
- [metadata]
7
- name = palvisualpy
8
- description = palvisualpy
9
- author = Tiny.Twist
10
- author_email = tiny.mahua@gmail.com
11
- license = MIT
12
- license_files = LICENSE.txt
13
- long_description = file: README.rst
14
- long_description_content_type = text/x-rst; charset=UTF-8
15
- url = https://github.com/pyscaffold/pyscaffold/
16
- # Add here related links, for example:
17
- project_urls =
18
- Documentation = https://pyscaffold.org/
19
- # Source = https://github.com/pyscaffold/pyscaffold/
20
- # Changelog = https://pyscaffold.org/en/latest/changelog.html
21
- # Tracker = https://github.com/pyscaffold/pyscaffold/issues
22
- # Conda-Forge = https://anaconda.org/conda-forge/pyscaffold
23
- # Download = https://pypi.org/project/PyScaffold/#files
24
- # Twitter = https://twitter.com/PyScaffold
25
-
26
- # Change if running only on Windows, Mac or Linux (comma-separated)
27
- platforms = any
28
-
29
- # Add here all kinds of additional classifiers as defined under
30
- # https://pypi.org/classifiers/
31
- classifiers =
32
- Development Status :: 4 - Beta
33
- Programming Language :: Python
34
-
35
-
36
- [options]
37
- zip_safe = False
38
- packages = find_namespace:
39
- include_package_data = True
40
- package_dir =
41
- =src
42
-
43
- # Require a min/specific Python version (comma-separated conditions)
44
- # python_requires = >=3.8
45
-
46
- # Add here dependencies of your project (line-separated), e.g. requests>=2.2,<3.0.
47
- # Version specifiers like >=2.2,<3.0 avoid problems due to API changes in
48
- # new major versions. This works if the required packages follow Semantic Versioning.
49
- # For more information, check out https://semver.org/.
50
- install_requires =
51
- importlib-metadata; python_version<"3.8"
52
-
53
-
54
- [options.packages.find]
55
- where = src
56
- exclude =
57
- tests
58
-
59
- [options.extras_require]
60
- # Add here additional requirements for extra features, to install with:
61
- # `pip install palvisualpy[PDF]` like:
62
- # PDF = ReportLab; RXP
63
-
64
- # Add here test requirements (semicolon/line-separated)
65
- testing =
66
- setuptools
67
- pytest
68
- pytest-cov
69
-
70
- [options.entry_points]
71
- # Add here console scripts like:
72
- # console_scripts =
73
- # script_name = palvisualpy.module:function
74
- # For example:
75
- # console_scripts =
76
- # fibonacci = palvisualpy.skeleton:run
77
- # And any other entry points, for example:
78
- # pyscaffold.cli =
79
- # awesome = pyscaffoldext.awesome.extension:AwesomeExtension
80
-
81
- [tool:pytest]
82
- # Specify command line options as you would do when invoking pytest directly.
83
- # e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml
84
- # in order to write a coverage file that can be read by Jenkins.
85
- # CAUTION: --cov flags may prohibit setting breakpoints while debugging.
86
- # Comment those flags to avoid this pytest issue.
87
- addopts =
88
- --cov palvisualpy --cov-report term-missing
89
- --verbose
90
- norecursedirs =
91
- dist
92
- build
93
- .tox
94
- testpaths = tests
95
- # Use pytest markers to select/deselect specific tests
96
- # markers =
97
- # slow: mark tests as slow (deselect with '-m "not slow"')
98
- # system: mark end-to-end system tests
99
-
100
- [devpi:upload]
101
- # Options for the devpi: PyPI server and packaging tool
102
- # VCS export must be deactivated since we are using setuptools-scm
103
- no_vcs = 1
104
- formats = bdist_wheel
105
-
106
- [flake8]
107
- # Some sane defaults for the code style checker flake8
108
- max_line_length = 88
109
- extend_ignore = E203, W503
110
- # ^ Black-compatible
111
- # E203 and W503 have edge cases handled by black
112
- exclude =
113
- .tox
114
- build
115
- dist
116
- .eggs
117
- docs/conf.py
118
-
119
- [pyscaffold]
120
- # PyScaffold's parameters when the project was created.
121
- # This will be used when updating. Do not change!
122
- version = 4.4
123
- package = palvisualpy
124
- extensions =
125
- no_skeleton
126
- no_tox
@@ -1,29 +0,0 @@
1
- """
2
- Setup file for palvisualpy.
3
- Use setup.cfg to configure your project.
4
-
5
- This file was generated with PyScaffold 4.4.
6
- PyScaffold helps you to put up the scaffold of your new Python project.
7
- Learn more under: https://pyscaffold.org/
8
- """
9
- from setuptools import setup
10
-
11
- if __name__ == "__main__":
12
- try:
13
- setup(
14
- name='palvisualpy',
15
- packages=['palvisualpy'],
16
- install_requires=[
17
- 'rich==13.3.5',
18
- 'flatdict==4.0.1',
19
- ],
20
- use_scm_version={"version_scheme": "no-guess-dev"}
21
- )
22
- except: # noqa
23
- print(
24
- "\n\nAn error occurred while building the project, "
25
- "please ensure you have the most updated version of setuptools, "
26
- "setuptools_scm and wheel with:\n"
27
- " pip install -U setuptools setuptools_scm wheel\n\n"
28
- )
29
- raise
@@ -1,10 +0,0 @@
1
- """
2
- Dummy conftest.py for palvisualpy.
3
-
4
- If you don't know what this is for, just leave it empty.
5
- Read more about conftest.py under:
6
- - https://docs.pytest.org/en/stable/fixture.html
7
- - https://docs.pytest.org/en/stable/writing_plugins.html
8
- """
9
-
10
- # import pytest
File without changes
File without changes