AirPlot 0.1.0__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.
@@ -0,0 +1,119 @@
1
+ # Contributing
2
+
3
+ Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4
+
5
+ You can contribute in many ways:
6
+
7
+ ## Types of Contributions
8
+
9
+ ### Report Bugs
10
+
11
+ Report bugs at https://github.com/feldroy/airplot/issues.
12
+
13
+ If you are reporting a bug, please include:
14
+
15
+ - Your operating system name and version.
16
+ - Any details about your local setup that might be helpful in troubleshooting.
17
+ - Detailed steps to reproduce the bug.
18
+
19
+ ### Fix Bugs
20
+
21
+ Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
22
+
23
+ ### Implement Features
24
+
25
+ Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
26
+
27
+ ### Write Documentation
28
+
29
+ AirPlot could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
30
+
31
+ ### Submit Feedback
32
+
33
+ The best way to send feedback is to file an issue at https://github.com/feldroy/airplot/issues.
34
+
35
+ If you are proposing a feature:
36
+
37
+ - Explain in detail how it would work.
38
+ - Keep the scope as narrow as possible, to make it easier to implement.
39
+ - Remember that this is a volunteer-driven project, and that contributions are welcome :)
40
+
41
+ ## Get Started!
42
+
43
+ Ready to contribute? Here's how to set up `airplot` for local development.
44
+
45
+ 1. Fork the `airplot` repo on GitHub.
46
+ 2. Clone your fork locally:
47
+
48
+ ```sh
49
+ git clone git@github.com:your_name_here/airplot.git
50
+ ```
51
+
52
+ 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
53
+
54
+ ```sh
55
+ mkvirtualenv airplot
56
+ cd airplot/
57
+ python setup.py develop
58
+ ```
59
+
60
+ 4. Create a branch for local development:
61
+
62
+ ```sh
63
+ git checkout -b name-of-your-bugfix-or-feature
64
+ ```
65
+
66
+ Now you can make your changes locally.
67
+
68
+ 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
69
+
70
+ ```sh
71
+ make lint
72
+ make test
73
+ # Or
74
+ make test-all
75
+ ```
76
+
77
+ To get flake8 and tox, just pip install them into your virtualenv.
78
+
79
+ 6. Commit your changes and push your branch to GitHub:
80
+
81
+ ```sh
82
+ git add .
83
+ git commit -m "Your detailed description of your changes."
84
+ git push origin name-of-your-bugfix-or-feature
85
+ ```
86
+
87
+ 7. Submit a pull request through the GitHub website.
88
+
89
+ ## Pull Request Guidelines
90
+
91
+ Before you submit a pull request, check that it meets these guidelines:
92
+
93
+ 1. The pull request should include tests.
94
+ 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
95
+ 3. The pull request should work for Python 3.12 and 3.13. Tests run in GitHub Actions on every pull request to the main branch, make sure that the tests pass for all supported Python versions.
96
+
97
+ ## Tips
98
+
99
+ To run a subset of tests:
100
+
101
+ ```sh
102
+ pytest tests.test_airplot
103
+ ```
104
+
105
+ ## Deploying
106
+
107
+ A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:
108
+
109
+ ```sh
110
+ bump2version patch # possible: major / minor / patch
111
+ git push
112
+ git push --tags
113
+ ```
114
+
115
+ You can set up a [GitHub Actions workflow](https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-python#publishing-to-pypi) to automatically deploy your package to PyPI when you push a new tag.
116
+
117
+ ## Code of Conduct
118
+
119
+ Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
@@ -0,0 +1,5 @@
1
+ # History
2
+
3
+ ## 0.1.0 (2026-03-23)
4
+
5
+ * First release on PyPI.
airplot-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026, Daniel Roy Greenfeld
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,10 @@
1
+ include CONTRIBUTING.md
2
+ include HISTORY.md
3
+ include LICENSE
4
+ include README.md
5
+
6
+ recursive-include tests *
7
+ recursive-exclude * __pycache__
8
+ recursive-exclude * *.py[co]
9
+
10
+ recursive-include docs *.md Makefile *.jpg *.png *.gif
airplot-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,40 @@
1
+ Metadata-Version: 2.4
2
+ Name: AirPlot
3
+ Version: 0.1.0
4
+ Summary: Charting for the Air Web Framework.
5
+ Author-email: Daniel Roy Greenfeld <daniel@feldroy.com>
6
+ Maintainer-email: Daniel Roy Greenfeld <daniel@feldroy.com>
7
+ License: MIT
8
+ Project-URL: bugs, https://github.com/feldroy/airplot/issues
9
+ Project-URL: changelog, https://github.com/feldroy/airplot/blob/master/changelog.md
10
+ Project-URL: homepage, https://github.com/feldroy/airplot
11
+ Requires-Python: >=3.10
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: typer
15
+ Provides-Extra: test
16
+ Requires-Dist: coverage; extra == "test"
17
+ Requires-Dist: pytest; extra == "test"
18
+ Requires-Dist: ruff; extra == "test"
19
+ Requires-Dist: ty; extra == "test"
20
+ Requires-Dist: ipdb; extra == "test"
21
+ Dynamic: license-file
22
+
23
+ # AirPlot
24
+
25
+ ![PyPI version](https://img.shields.io/pypi/v/airplot.svg)
26
+ [![Documentation Status](https://readthedocs.org/projects/airplot/badge/?version=latest)](https://airplot.readthedocs.io/en/latest/?version=latest)
27
+
28
+ Charting for the Air Web Framework.
29
+
30
+ * PyPI package: https://pypi.org/project/airplot/
31
+ * Free software: MIT License
32
+ * Documentation: https://airplot.readthedocs.io.
33
+
34
+ ## Features
35
+
36
+ * TODO
37
+
38
+ ## Credits
39
+
40
+ This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
@@ -0,0 +1,18 @@
1
+ # AirPlot
2
+
3
+ ![PyPI version](https://img.shields.io/pypi/v/airplot.svg)
4
+ [![Documentation Status](https://readthedocs.org/projects/airplot/badge/?version=latest)](https://airplot.readthedocs.io/en/latest/?version=latest)
5
+
6
+ Charting for the Air Web Framework.
7
+
8
+ * PyPI package: https://pypi.org/project/airplot/
9
+ * Free software: MIT License
10
+ * Documentation: https://airplot.readthedocs.io.
11
+
12
+ ## Features
13
+
14
+ * TODO
15
+
16
+ ## Credits
17
+
18
+ This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
@@ -0,0 +1,16 @@
1
+ # Welcome to AirPlot's documentation!
2
+
3
+ ## Contents
4
+
5
+ - [Readme](readme.md)
6
+ - [Installation](installation.md)
7
+ - [Usage](usage.md)
8
+ - [Modules](modules.md)
9
+ - [Contributing](contributing.md)
10
+ - [History](history.md)
11
+
12
+ ## Indices and tables
13
+
14
+ - [Index](genindex)
15
+ - [Module Index](modindex)
16
+ - [Search](search)
@@ -0,0 +1,38 @@
1
+ # Installation
2
+
3
+ ## Stable release
4
+
5
+ To install AirPlot, run this command in your terminal:
6
+
7
+ ```sh
8
+ uv add airplot
9
+ ```
10
+
11
+ Or if you prefer to use `pip`:
12
+
13
+ ```sh
14
+ pip install airplot
15
+ ```
16
+
17
+ ## From source
18
+
19
+ The source files for AirPlot can be downloaded from the [Github repo](https://github.com/feldroy/airplot).
20
+
21
+ You can either clone the public repository:
22
+
23
+ ```sh
24
+ git clone git://github.com/feldroy/airplot
25
+ ```
26
+
27
+ Or download the [tarball](https://github.com/feldroy/airplot/tarball/master):
28
+
29
+ ```sh
30
+ curl -OJL https://github.com/feldroy/airplot/tarball/master
31
+ ```
32
+
33
+ Once you have a copy of the source, you can install it with:
34
+
35
+ ```sh
36
+ cd airplot
37
+ uv pip install .
38
+ ```
@@ -0,0 +1,7 @@
1
+ # Usage
2
+
3
+ To use AirPlot in a project:
4
+
5
+ ```python
6
+ import airplot
7
+ ```
@@ -0,0 +1,57 @@
1
+ [project]
2
+ name = "AirPlot"
3
+ version = "0.1.0"
4
+ description = "Charting for the Air Web Framework."
5
+ readme = "README.md"
6
+ authors = [
7
+ {name = "Daniel Roy Greenfeld", email = "daniel@feldroy.com"}
8
+ ]
9
+ maintainers = [
10
+ {name = "Daniel Roy Greenfeld", email = "daniel@feldroy.com"}
11
+ ]
12
+ classifiers = [
13
+ # TODO
14
+ ]
15
+ license = {text = "MIT"}
16
+ dependencies = [
17
+ "typer"
18
+ ]
19
+ requires-python = ">= 3.10"
20
+
21
+ [project.optional-dependencies]
22
+ test = [
23
+ "coverage", # testing
24
+ "pytest", # testing
25
+ "ruff", # linting
26
+ "ty", # checking types
27
+ "ipdb", # debugging
28
+ ]
29
+
30
+ [project.urls]
31
+ bugs = "https://github.com/feldroy/airplot/issues"
32
+ changelog = "https://github.com/feldroy/airplot/blob/master/changelog.md"
33
+ homepage = "https://github.com/feldroy/airplot"
34
+
35
+ [project.scripts]
36
+ airplot = "airplot.cli:app"
37
+
38
+ [tool.ty]
39
+ # All rules are enabled as "error" by default; no need to specify unless overriding.
40
+ # Example override: relax a rule for the entire project (uncomment if needed).
41
+ # rules.TY015 = "warn" # For invalid-argument-type, warn instead of error.
42
+
43
+ [tool.ruff]
44
+ line-length = 120
45
+
46
+ [tool.ruff.lint]
47
+ select = [
48
+ "E", # pycodestyle errors
49
+ "W", # pycodestyle warnings
50
+ "F", # Pyflakes
51
+ "I", # isort
52
+ "B", # flake8-bugbear
53
+ "UP", # pyupgrade
54
+ ]
55
+
56
+ [tool.uv]
57
+ package = true
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,40 @@
1
+ Metadata-Version: 2.4
2
+ Name: AirPlot
3
+ Version: 0.1.0
4
+ Summary: Charting for the Air Web Framework.
5
+ Author-email: Daniel Roy Greenfeld <daniel@feldroy.com>
6
+ Maintainer-email: Daniel Roy Greenfeld <daniel@feldroy.com>
7
+ License: MIT
8
+ Project-URL: bugs, https://github.com/feldroy/airplot/issues
9
+ Project-URL: changelog, https://github.com/feldroy/airplot/blob/master/changelog.md
10
+ Project-URL: homepage, https://github.com/feldroy/airplot
11
+ Requires-Python: >=3.10
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: typer
15
+ Provides-Extra: test
16
+ Requires-Dist: coverage; extra == "test"
17
+ Requires-Dist: pytest; extra == "test"
18
+ Requires-Dist: ruff; extra == "test"
19
+ Requires-Dist: ty; extra == "test"
20
+ Requires-Dist: ipdb; extra == "test"
21
+ Dynamic: license-file
22
+
23
+ # AirPlot
24
+
25
+ ![PyPI version](https://img.shields.io/pypi/v/airplot.svg)
26
+ [![Documentation Status](https://readthedocs.org/projects/airplot/badge/?version=latest)](https://airplot.readthedocs.io/en/latest/?version=latest)
27
+
28
+ Charting for the Air Web Framework.
29
+
30
+ * PyPI package: https://pypi.org/project/airplot/
31
+ * Free software: MIT License
32
+ * Documentation: https://airplot.readthedocs.io.
33
+
34
+ ## Features
35
+
36
+ * TODO
37
+
38
+ ## Credits
39
+
40
+ This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
@@ -0,0 +1,22 @@
1
+ CONTRIBUTING.md
2
+ HISTORY.md
3
+ LICENSE
4
+ MANIFEST.in
5
+ README.md
6
+ pyproject.toml
7
+ docs/index.md
8
+ docs/installation.md
9
+ docs/usage.md
10
+ src/AirPlot.egg-info/PKG-INFO
11
+ src/AirPlot.egg-info/SOURCES.txt
12
+ src/AirPlot.egg-info/dependency_links.txt
13
+ src/AirPlot.egg-info/entry_points.txt
14
+ src/AirPlot.egg-info/requires.txt
15
+ src/AirPlot.egg-info/top_level.txt
16
+ src/airplot/__init__.py
17
+ src/airplot/__main__.py
18
+ src/airplot/airplot.py
19
+ src/airplot/cli.py
20
+ src/airplot/utils.py
21
+ tests/__init__.py
22
+ tests/test_airplot.py
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ airplot = airplot.cli:app
@@ -0,0 +1,8 @@
1
+ typer
2
+
3
+ [test]
4
+ coverage
5
+ pytest
6
+ ruff
7
+ ty
8
+ ipdb
@@ -0,0 +1 @@
1
+ airplot
@@ -0,0 +1,4 @@
1
+ """Top-level package for AirPlot."""
2
+
3
+ __author__ = """Daniel Roy Greenfeld"""
4
+ __email__ = 'daniel@feldroy.com'
@@ -0,0 +1,4 @@
1
+ from .cli import app
2
+
3
+ if __name__ == "__main__":
4
+ app()
@@ -0,0 +1 @@
1
+ """Main module."""
@@ -0,0 +1,22 @@
1
+ """Console script for airplot."""
2
+
3
+ import typer
4
+ from rich.console import Console
5
+
6
+ from airplot import utils
7
+
8
+ app = typer.Typer()
9
+ console = Console()
10
+
11
+
12
+ @app.command()
13
+ def main():
14
+ """Console script for airplot."""
15
+ console.print("Replace this message by putting your code into "
16
+ "airplot.cli.main")
17
+ console.print("See Typer documentation at https://typer.tiangolo.com/")
18
+ utils.do_something_useful()
19
+
20
+
21
+ if __name__ == "__main__":
22
+ app()
@@ -0,0 +1,2 @@
1
+ def do_something_useful():
2
+ print("Replace this with a utility function")
@@ -0,0 +1 @@
1
+ """Unit test package for airplot."""
@@ -0,0 +1,22 @@
1
+ #!/usr/bin/env python
2
+ import pytest
3
+
4
+ """Tests for `airplot` package."""
5
+
6
+ # from airplot import airplot
7
+
8
+
9
+ @pytest.fixture
10
+ def response():
11
+ """Sample pytest fixture.
12
+
13
+ See more at: http://doc.pytest.org/en/latest/fixture.html
14
+ """
15
+ # import requests
16
+ # return requests.get('https://github.com/audreyfeldroy/cookiecutter-pypackage')
17
+
18
+
19
+ def test_content(response):
20
+ """Sample pytest test function with the pytest fixture as an argument."""
21
+ # from bs4 import BeautifulSoup
22
+ # assert 'GitHub' in BeautifulSoup(response.content).title.string