python-plugins 0.1.0__tar.gz

python_plugins-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Publish Python distribution to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v**'
+  
+
+jobs:
+  release-build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+          pip install build
+
+      - name: Build release distributions
+        run: |
+          python -m build
+
+      - name: Upload the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    name: Publish Python distribution to PyPI
+    if: startsWith(github.ref, 'refs/tags/')   # only publish to PyPI on tag pushes
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/Python-Plugins
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        

python_plugins-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+### vscode
+.vscode
+
+### JupyterNotebooks ###
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+venv/
+
+# Distribution / packaging
+dist/
+build/
+
+# Unit test / coverage reports
+.cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Sphinx documentation
+docs/_build/

python_plugins-0.1.0/.readthedocs.yaml

@@ -0,0 +1,39 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+

python_plugins-0.1.0/CHANGES.rst

@@ -0,0 +1,6 @@
+v0.1.0
+------
+
+Released 2024-08-27
+
+- Init release

python_plugins-0.1.0/LICENSE.rst

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present huadong <david.dong.hua@gmail.com>
+
+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.

python_plugins-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.3
+Name: python-plugins
+Version: 0.1.0
+Summary: A collection of Python functions and classes.
+Project-URL: Documentation, https://python-plugins.readthedocs.io
+Project-URL: Source, https://github.com/ojso/python-plugins
+Project-URL: Homepage, https://github.com/ojso/python-plugins
+Author-email: huadong <david.dong.hua@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024-present huadong <david.dong.hua@gmail.com>
+        
+        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.
+License-File: LICENSE.rst
+Keywords: plugin,utils
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+
+python-plugins
+=====================
+
+python-plugins is a collection of Python plugins, functions and classes.
+
+License
+-------
+
+python-plugins is distributed under the terms of the `MIT <https://opensource.org/licenses/MIT>`_.
+
+
+Installation
+------------
+
+Install and update using pip:
+
+.. code-block:: console
+
+    $ pip install -U python-plugins
+

python_plugins-0.1.0/README.rst

@@ -0,0 +1,20 @@
+python-plugins
+=====================
+
+python-plugins is a collection of Python plugins, functions and classes.
+
+License
+-------
+
+python-plugins is distributed under the terms of the `MIT <https://opensource.org/licenses/MIT>`_.
+
+
+Installation
+------------
+
+Install and update using pip:
+
+.. code-block:: console
+
+    $ pip install -U python-plugins
+

python_plugins-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

python_plugins-0.1.0/docs/api.rst

@@ -0,0 +1,4 @@
+API
+===
+
+

python_plugins-0.1.0/docs/changes.rst

@@ -0,0 +1,4 @@
+Changes
+=======
+
+.. include:: ../CHANGES.rst

python_plugins-0.1.0/docs/conf.py

@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'python-plugins'
+copyright = '2024, HuaDong'
+author = 'HuaDong'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.doctest',    
+    'sphinx.ext.autosummary',    
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'classic'
+html_static_path = ['_static']
+html_title = "python-plugins Documentation"

python_plugins-0.1.0/docs/examples.rst

@@ -0,0 +1 @@
+.. include:: ../examples/README.rst

python_plugins-0.1.0/docs/index.rst

@@ -0,0 +1,20 @@
+Welcome to python-plugins's documentation!
+============================================
+
+**python-plugins** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage
+   api
+   examples
+   changes
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

python_plugins-0.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

python_plugins-0.1.0/docs/requirements.txt

@@ -0,0 +1,2 @@
+# Defining the exact version will make sure things don't break
+sphinx

python_plugins-0.1.0/docs/usage.rst

@@ -0,0 +1,14 @@
+=====
+Usage
+=====
+
+.. _installation:
+
+Installation
+==============
+
+Install and update using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install -U python-plugins

python_plugins-0.1.0/examples/README.rst

@@ -0,0 +1,17 @@
+=============
+Examples
+=============
+
+Install
+=========
+
+Type these commands in the terminal:
+
+.. code-block:: bash
+
+    $ git clone https://github.com/ojso/python-plugins.git
+    $ cd python-plugins/examples
+    $ python3 -m venv venv
+    $ source venv/bin/activate
+    $ pip install python-plugins
+    

python_plugins-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-plugins"
+dynamic = ["version"]
+description = 'A collection of Python functions and classes.'
+readme = "README.rst"
+license = { file = "LICENSE.rst" }
+keywords = ["plugin", "utils"]
+authors = [
+  { name = "huadong", email = "david.dong.hua@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Topic :: Software Development :: Build Tools",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+]
+requires-python = ">=3.10"
+dependencies = [
+]
+
+[project.urls]
+Documentation = "https://python-plugins.readthedocs.io"
+Source = "https://github.com/ojso/python-plugins"
+Homepage = "https://github.com/ojso/python-plugins"
+
+[tool.hatch.version]
+path = "src/python_plugins/__about__.py"

python_plugins-0.1.0/requirements/build.in

@@ -0,0 +1,2 @@
+hatch
+build

python_plugins-0.1.0/src/python_plugins/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

python_plugins-0.1.0/src/python_plugins/__init__.py

@@ -0,0 +1 @@
+

python_plugins-0.1.0/tests/__init__.py

@@ -0,0 +1 @@
+