fruxon 0.1.0__tar.gz

fruxon-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/HagaiCo/fruxon/issues.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+fruxon 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.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/HagaiCo/fruxon/issues.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `fruxon` for local development.
+
+1. Fork the `fruxon` repo on GitHub.
+2. Clone your fork locally:
+
+   ```sh
+   git clone git@github.com:your_name_here/fruxon.git
+   ```
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
+
+   ```sh
+   mkvirtualenv fruxon
+   cd fruxon/
+   python setup.py develop
+   ```
+
+4. Create a branch for local development:
+
+   ```sh
+   git checkout -b name-of-your-bugfix-or-feature
+   ```
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
+
+   ```sh
+   make lint
+   make test
+   # Or
+   make test-all
+   ```
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub:
+
+   ```sh
+   git add .
+   git commit -m "Your detailed description of your changes."
+   git push origin name-of-your-bugfix-or-feature
+   ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+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.
+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.
+
+## Tips
+
+To run a subset of tests:
+
+```sh
+pytest tests.test_fruxon
+```
+
+## Deploying
+
+A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:
+
+```sh
+bump2version patch # possible: major / minor / patch
+git push
+git push --tags
+```
+
+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.
+
+## Code of Conduct
+
+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.

fruxon-0.1.0/HISTORY.md

@@ -0,0 +1,5 @@
+# History
+
+## 0.1.0 (2025-09-26)
+
+* First release on PyPI.

fruxon-0.1.0/LICENSE

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

fruxon-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include CONTRIBUTING.md
+include HISTORY.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.md Makefile *.jpg *.png *.gif

fruxon-0.1.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: fruxon
+Version: 0.1.0
+Summary: The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform.
+Author-email: Hagai Cohen <hagai@fruxon.com>
+Maintainer-email: Hagai Cohen <hagai@fruxon.com>
+License: MIT
+Project-URL: bugs, https://github.com/HagaiCo/fruxon/issues
+Project-URL: changelog, https://github.com/HagaiCo/fruxon/blob/master/changelog.md
+Project-URL: homepage, https://github.com/HagaiCo/fruxon
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: ty; extra == "test"
+Requires-Dist: ipdb; extra == "test"
+Dynamic: license-file
+
+# fruxon
+
+![PyPI version](https://img.shields.io/pypi/v/fruxon.svg)
+[![Documentation Status](https://readthedocs.org/projects/fruxon/badge/?version=latest)](https://fruxon.readthedocs.io/en/latest/?version=latest)
+
+The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform.
+
+* PyPI package: https://pypi.org/project/fruxon/
+* Free software: MIT License
+* Documentation: https://fruxon.readthedocs.io.
+
+## Features
+
+* TODO
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.

fruxon-0.1.0/README.md

@@ -0,0 +1,18 @@
+# fruxon
+
+![PyPI version](https://img.shields.io/pypi/v/fruxon.svg)
+[![Documentation Status](https://readthedocs.org/projects/fruxon/badge/?version=latest)](https://fruxon.readthedocs.io/en/latest/?version=latest)
+
+The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform.
+
+* PyPI package: https://pypi.org/project/fruxon/
+* Free software: MIT License
+* Documentation: https://fruxon.readthedocs.io.
+
+## Features
+
+* TODO
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.

fruxon-0.1.0/docs/index.md

@@ -0,0 +1,16 @@
+# Welcome to fruxon's documentation!
+
+## Contents
+
+- [Readme](readme.md)
+- [Installation](installation.md)
+- [Usage](usage.md)
+- [Modules](modules.md)
+- [Contributing](contributing.md)
+- [History](history.md)
+
+## Indices and tables
+
+- [Index](genindex)
+- [Module Index](modindex)
+- [Search](search)

fruxon-0.1.0/docs/installation.md

@@ -0,0 +1,38 @@
+# Installation
+
+## Stable release
+
+To install fruxon, run this command in your terminal:
+
+```sh
+uv add fruxon
+```
+
+Or if you prefer to use `pip`:
+
+```sh
+pip install fruxon
+```
+
+## From source
+
+The source files for fruxon can be downloaded from the [Github repo](https://github.com/HagaiCo/fruxon).
+
+You can either clone the public repository:
+
+```sh
+git clone git://github.com/HagaiCo/fruxon
+```
+
+Or download the [tarball](https://github.com/HagaiCo/fruxon/tarball/master):
+
+```sh
+curl -OJL https://github.com/HagaiCo/fruxon/tarball/master
+```
+
+Once you have a copy of the source, you can install it with:
+
+```sh
+cd fruxon
+uv pip install .
+```

fruxon-0.1.0/docs/usage.md

@@ -0,0 +1,7 @@
+# Usage
+
+To use fruxon in a project:
+
+```python
+import fruxon
+```

fruxon-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "fruxon"
+version = "0.1.0"
+description = "The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform."
+readme = "README.md"
+authors = [
+  {name = "Hagai Cohen", email = "hagai@fruxon.com"}
+]
+maintainers = [
+  {name = "Hagai Cohen", email = "hagai@fruxon.com"}
+]
+classifiers = [
+    # TODO
+]
+license = {text = "MIT"}
+dependencies = [
+  "typer"
+]
+requires-python = ">= 3.10"
+
+[project.optional-dependencies]
+test = [
+    "coverage",  # testing
+    "pytest",  # testing
+    "ruff",  # linting
+    "ty", # checking types
+    "ipdb", # debugging
+]
+
+[project.urls]
+bugs = "https://github.com/HagaiCo/fruxon/issues"
+changelog = "https://github.com/HagaiCo/fruxon/blob/master/changelog.md"
+homepage = "https://github.com/HagaiCo/fruxon"
+
+[project.scripts]
+fruxon = "fruxon.cli:app"
+
+[tool.ty]
+# All rules are enabled as "error" by default; no need to specify unless overriding.
+# Example override: relax a rule for the entire project (uncomment if needed).
+# rules.TY015 = "warn"  # For invalid-argument-type, warn instead of error.
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # Pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+]
+
+[tool.uv]
+package = true

fruxon-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fruxon-0.1.0/src/fruxon/__init__.py

@@ -0,0 +1,4 @@
+"""Top-level package for fruxon."""
+
+__author__ = """Hagai Cohen"""
+__email__ = 'hagai@fruxon.com'

fruxon-0.1.0/src/fruxon/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

fruxon-0.1.0/src/fruxon/cli.py

@@ -0,0 +1,22 @@
+"""Console script for fruxon."""
+
+import typer
+from rich.console import Console
+
+from fruxon import utils
+
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def main():
+    """Console script for fruxon."""
+    console.print("Replace this message by putting your code into "
+               "fruxon.cli.main")
+    console.print("See Typer documentation at https://typer.tiangolo.com/")
+    utils.do_something_useful()
+
+
+if __name__ == "__main__":
+    app()

fruxon-0.1.0/src/fruxon/fruxon.py

@@ -0,0 +1 @@
+"""Main module."""

fruxon-0.1.0/src/fruxon/utils.py

@@ -0,0 +1,2 @@
+def do_something_useful():
+    print("Replace this with a utility function")

fruxon-0.1.0/src/fruxon.egg-info/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: fruxon
+Version: 0.1.0
+Summary: The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform.
+Author-email: Hagai Cohen <hagai@fruxon.com>
+Maintainer-email: Hagai Cohen <hagai@fruxon.com>
+License: MIT
+Project-URL: bugs, https://github.com/HagaiCo/fruxon/issues
+Project-URL: changelog, https://github.com/HagaiCo/fruxon/blob/master/changelog.md
+Project-URL: homepage, https://github.com/HagaiCo/fruxon
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: ty; extra == "test"
+Requires-Dist: ipdb; extra == "test"
+Dynamic: license-file
+
+# fruxon
+
+![PyPI version](https://img.shields.io/pypi/v/fruxon.svg)
+[![Documentation Status](https://readthedocs.org/projects/fruxon/badge/?version=latest)](https://fruxon.readthedocs.io/en/latest/?version=latest)
+
+The Fruxon SDK is a lightweight Python client for integrating with the Fruxon platform.
+
+* PyPI package: https://pypi.org/project/fruxon/
+* Free software: MIT License
+* Documentation: https://fruxon.readthedocs.io.
+
+## Features
+
+* TODO
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.

fruxon-0.1.0/src/fruxon.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+CONTRIBUTING.md
+HISTORY.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+docs/index.md
+docs/installation.md
+docs/usage.md
+src/fruxon/__init__.py
+src/fruxon/__main__.py
+src/fruxon/cli.py
+src/fruxon/fruxon.py
+src/fruxon/utils.py
+src/fruxon.egg-info/PKG-INFO
+src/fruxon.egg-info/SOURCES.txt
+src/fruxon.egg-info/dependency_links.txt
+src/fruxon.egg-info/entry_points.txt
+src/fruxon.egg-info/requires.txt
+src/fruxon.egg-info/top_level.txt
+tests/__init__.py
+tests/test_fruxon.py

fruxon-0.1.0/src/fruxon.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fruxon-0.1.0/src/fruxon.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fruxon = fruxon.cli:app

fruxon-0.1.0/src/fruxon.egg-info/requires.txt

@@ -0,0 +1,8 @@
+typer
+
+[test]
+coverage
+pytest
+ruff
+ty
+ipdb

fruxon-0.1.0/src/fruxon.egg-info/top_level.txt

@@ -0,0 +1 @@
+fruxon

fruxon-0.1.0/tests/__init__.py

@@ -0,0 +1 @@
+"""Unit test package for fruxon."""

fruxon-0.1.0/tests/test_fruxon.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import pytest
+
+"""Tests for `fruxon` package."""
+
+# from fruxon import fruxon
+
+
+@pytest.fixture
+def response():
+    """Sample pytest fixture.
+
+    See more at: http://doc.pytest.org/en/latest/fixture.html
+    """
+    # import requests
+    # return requests.get('https://github.com/audreyfeldroy/cookiecutter-pypackage')
+
+
+def test_content(response):
+    """Sample pytest test function with the pytest fixture as an argument."""
+    # from bs4 import BeautifulSoup
+    # assert 'GitHub' in BeautifulSoup(response.content).title.string