From 109789fe78d12df06a6ffb1f4a9aec661860e967 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 26 Sep 2024 17:49:16 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager --- .gitea/workflows/python-package.yml | 16 ++++++ .gitea/workflows/python-test.yml | 9 ++++ .gitignore | 20 ++++++++ LICENSE | 21 ++++++++ README.md | 37 +++++++++++++- favro_sync/__init__.py | 2 +- favro_sync/_version.py | 1 + ruff.toml | 79 +++++++++++++++++++++++++++++ setup.py | 61 +++++++++++++++++++++- 9 files changed, 243 insertions(+), 3 deletions(-) create mode 100644 .gitea/workflows/python-package.yml create mode 100644 .gitea/workflows/python-test.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 favro_sync/_version.py create mode 100644 ruff.toml diff --git a/.gitea/workflows/python-package.yml b/.gitea/workflows/python-package.yml new file mode 100644 index 0000000..c29c732 --- /dev/null +++ b/.gitea/workflows/python-package.yml @@ -0,0 +1,16 @@ +name: Package Python +on: + push: + tags: + - 'v[0-9]+.[0-9]+.[0-9]+' + paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"] + +jobs: + Package: + uses: jmaa/workflows/.gitea/workflows/python-package.yaml@v6.21 + with: + REGISTRY_DOMAIN: gitfub.space + REGISTRY_ORGANIZATION: usagi-keiretsu + secrets: + PIPY_REPO_USER: ${{ secrets.PIPY_REPO_USER }} + PIPY_REPO_PASS: ${{ secrets.PIPY_REPO_PASS }} diff --git a/.gitea/workflows/python-test.yml b/.gitea/workflows/python-test.yml new file mode 100644 index 0000000..d85fe9a --- /dev/null +++ b/.gitea/workflows/python-test.yml @@ -0,0 +1,9 @@ +name: Test Python + +on: + push: + paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"] + +jobs: + Test: + uses: jmaa/workflows/.gitea/workflows/python-test.yaml@v6.21 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..41180b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +# Program specific +/output/ +/deps/ +/secrets +/private_deps/ +/data/ +/config/ + +# Python +__pycache__/ +/build/ +/dist/ +*.egg-info/ +.mypy_cache/ + +# Python, Testing +/test/secrets.py +/.coverage +/.hypothesis/ +/htmlcov/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..67061b0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Jon Michael Aanes + +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. diff --git a/README.md b/README.md index 918847d..08075db 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ + + + -TODO: Hook into repo-manager. + +# Favro Sync. + +Filesystem in User Space for Favro. + +Synchronize your local notes and your Favro. + + +# License + +``` +MIT License + +Copyright (c) 2024 Jon Michael Aanes + +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. +``` diff --git a/favro_sync/__init__.py b/favro_sync/__init__.py index 6447f70..97fb381 100644 --- a/favro_sync/__init__.py +++ b/favro_sync/__init__.py @@ -1,6 +1,6 @@ """# Favro Sync. -FUSE (Filesystem in User Space) for Favro. +Filesystem in User Space for Favro. Synchronize your local notes and your Favro. """ diff --git a/favro_sync/_version.py b/favro_sync/_version.py new file mode 100644 index 0000000..38df384 --- /dev/null +++ b/favro_sync/_version.py @@ -0,0 +1 @@ +__VERSION__ = '0.1.0' diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..317a9a2 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,79 @@ +#[tool.ruff] +lint.select = [ 'ALL' ] +lint.ignore = [ + 'ANN', # Type annotations (lots of work.) + 'FBT', # Boolean trap is bullshit. + 'C90', 'PLR0911', 'PLR0915', 'PLR0913', # Code complexity measures are bullshit. + 'Q003', 'D205', # Format conflict + + 'TCH', # Microoptimization at the cost of readability + 'TID252', # I like relative imports + + 'D407', 'D413', # Weird documentation stuff + + 'D100', 'D101', 'D102', 'D103', 'D104', 'D105', 'D106', 'D107', 'D300', 'D401', # Missing docstrings (lots of work) + 'TD002', 'TD003', 'TD004', 'FIX', # Who cares about TODO standards? + "E501", 'PLR0912', 'PTH123', 'F405', 'E402', 'PLW0603', + + 'SIM102', + + 'TRY002', 'TRY003', +] + +# Autofix +lint.fixable = [ + 'SIM', 'C', 'Q', + 'UP035', 'UP004', 'UP032', 'UP006', 'UP007', 'I001', + 'F401', 'COM812', 'B011', 'PLR1722', 'PLR0402', 'S101', +] +lint.unfixable = ['SIM102', 'SIM114'] + +# Exclude a variety of commonly ignored directories. +exclude = [ + ".bzr", + ".direnv", + ".eggs", + ".git", + ".hg", + ".mypy_cache", + ".nox", + ".pants.d", + ".pytype", + ".ruff_cache", + ".svn", + ".tox", + ".venv", + "__pypackages__", + "_build", + "buck-out", + "build", + "dist", + "node_modules", + "venv", +] + +# Same as Black. +line-length = 88 + +# Allow unused variables when underscore-prefixed. +lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" + +# Assume Python 3.10. +target-version = "py310" + +[lint.flake8-quotes] +inline-quotes = "single" +multiline-quotes = "double" +docstring-quotes = "double" + +[format] +quote-style = "single" +indent-style = "space" +docstring-code-format = true + +[lint.per-file-ignores] +"test/*" = [ + "S101", # Test Asserts + "T201", # Debug prints + "PLR2004", # magic-value-comparison +] diff --git a/setup.py b/setup.py index 4640904..6585d92 100644 --- a/setup.py +++ b/setup.py @@ -1 +1,60 @@ -# TODO +# WARNING +# +# THIS IS AN AUTOGENERATED FILE. +# +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN. + +import re + +from setuptools import setup + +PACKAGE_NAME = 'favro_sync' + +PACKAGE_DESCRIPTION = """ +# Favro Sync. + +Filesystem in User Space for Favro. + +Synchronize your local notes and your Favro. +""".strip() + +PACKAGE_DESCRIPTION_SHORT = """ +Filesystem in User Space for Favro.""".strip() + + +def parse_version_file(text: str) -> str: + match = re.match(r'^__version__\s*=\s*(["\'])([\d\.]+)\1$', text) + if match is None: + msg = 'Malformed _version.py file!' + raise Exception(msg) + return match.group(2) + + +with open(PACKAGE_NAME + '/_version.py') as f: + version = parse_version_file(f.read()) + + +REQUIREMENTS_MAIN = [ + 'requests', + 'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader', +] +REQUIREMENTS_TEST = [ +] + + +setup( + name=PACKAGE_NAME, + version=version, + description=PACKAGE_DESCRIPTION_SHORT, + long_description=PACKAGE_DESCRIPTION, + long_description_content_type='text/markdown', + author='Jon Michael Aanes', + author_email='jonjmaa@gmail.com', + url='https://gitfub.space/Jmaa/' + PACKAGE_NAME, + packages=[PACKAGE_NAME], + install_requires=REQUIREMENTS_MAIN, + extras_require={ + 'test': REQUIREMENTS_TEST, + }, + python_requires='>=3.9', +)