fleche 0.1.0__tar.gz

fleche-0.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,25 @@
+on:
+  release:
+    types: [published]
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fleche
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+    # retrieve your distributions here
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Build
+      shell: bash
+      run: |
+        pip install build
+        python -m build --sdist
+    - name: pypi-publish
+      uses: pypa/gh-action-pypi-publish@v1.13.0

fleche-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

fleche-0.1.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: fleche
+Version: 0.1.0
+Author-email: Marvin Poul <pmrv@posteo.de>
+License-Expression: BSD-3-Clause
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.14,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cloudpickle
+Requires-Dist: sqlalchemy
+Requires-Dist: bagofholding
+Requires-Dist: numpy
+Requires-Dist: pandas<4,>=3
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs-autoapi; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Requires-Dist: griffe_fieldz; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Dynamic: license-file
+
+# fleche
+
+fleche is a persistant caching solution for arbitrary python functions.
+
+flèche is French for 'arrow' and also used in fencing as a fast attack.

fleche-0.1.0/README.md

@@ -0,0 +1,5 @@
+# fleche
+
+fleche is a persistant caching solution for arbitrary python functions.
+
+flèche is French for 'arrow' and also used in fencing as a fast attack.

fleche-0.1.0/docs/index.md

@@ -0,0 +1,13 @@
+---
+home: true
+---
+# Fleche Documentation
+
+Welcome to the **Fleche** library documentation.
+
+- **What is Fleche?**  A lightweight library for ... (provide brief description).
+- **Key features** – …
+- **Get started** – see the [Installation guide](installation.md).
+
+---
+*Generated with MkDocs and mkdocs-autoapi.*

fleche-0.1.0/docs/installation.md

@@ -0,0 +1,33 @@
+# Installation Guide
+
+## Normal installation
+
+```bash
+pip install fleche
+```
+
+## Installing documentation (optional)
+
+The documentation relies on a few extra packages.  They are provided as an optional
+extra named `docs`.  To install them together with the library you can run:
+
+```bash
+pip install "fleche[docs]"
+```
+
+If you are developing the project in an editable checkout, use:
+
+```bash
+pip install -e .[docs]
+```
+
+## Building the docs locally
+
+Once the optional dependencies are installed you can serve the documentation
+locally with:
+
+```bash
+mkdocs serve
+```
+
+Open <http://127.0.0.1:8000> in a browser to view the site.

fleche-0.1.0/mkdocs.yml

@@ -0,0 +1,48 @@
+# mkdocs.yml configuration for Fleche documentation
+
+site_name: Fleche
+site_url: https://example.com/fleche
+nav:
+  - Home: index.md
+  - Installation: installation.md
+
+
+theme:
+  name: readthedocs
+
+plugins:
+  - search
+  - mkdocs-autoapi:
+      autoapi_dir: src/
+      autoapi_ignore:
+        - fleche/_version.py
+      # Option to add the generated API to navigation automatically.
+      autoapi_add_nav_entry: Reference
+  - mkdocstrings:
+      handlers:
+        python:
+          paths:
+            - src/
+          options:
+            # Show members, docstrings, signatures, etc.
+            show_root_heading: true
+            members: true
+            heading_level: 2
+            summary: true
+            extensions:
+              - griffe_fieldz: {include_inherited: true}
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true
+  - pymdownx.superfences
+  - pymdownx.inlinehilite
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.tasklist:
+      custom_checkbox: true
+
+# The docs are built into the `site` directory by default.
+# No GitHub Pages deployment is configured per user request.