s3func 0.1.0__tar.gz

s3func-0.1.0/.gitignore

@@ -0,0 +1,115 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit/
+junit.xml
+test.db
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# .vscode
+.vscode/
+
+# OS files
+.DS_Store
+
+# S3 config file for tests
+s3func/tests/s3_config.toml
+

s3func-0.1.0/LICENSE

@@ -0,0 +1,16 @@
+Apache Software License 2.0
+
+Copyright (c) 2024, Mike Kittridge
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

s3func-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.3
+Name: s3func
+Version: 0.1.0
+Summary: Simple functions for working with S3
+Project-URL: Documentation, https://mullenkamp.github.io/s3func/
+Project-URL: Source, https://github.com/mullenkamp/s3func
+Author-email: s3func <mullenkamp1@gmail.com>
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Requires-Dist: boto3
+Requires-Dist: pydantic
+Requires-Dist: urllib3
+Description-Content-Type: text/markdown
+
+# s3func
+
+<p align="center">
+    <em>Simple functions for working with S3</em>
+</p>
+
+[![build](https://github.com/mullenkamp/s3func/workflows/Build/badge.svg)](https://github.com/mullenkamp/s3func/actions)
+[![codecov](https://codecov.io/gh/mullenkamp/s3func/branch/master/graph/badge.svg)](https://codecov.io/gh/mullenkamp/s3func)
+[![PyPI version](https://badge.fury.io/py/s3func.svg)](https://badge.fury.io/py/s3func)
+
+---
+
+**Documentation**: <a href="https://mullenkamp.github.io/s3func/" target="_blank">https://mullenkamp.github.io/s3func/</a>
+
+**Source Code**: <a href="https://github.com/mullenkamp/s3func" target="_blank">https://github.com/mullenkamp/s3func</a>
+
+---
+
+## Development
+
+### Setup environment
+
+We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+hatch run test
+```
+
+### Format the code
+
+Execute the following command to apply linting and check typing:
+
+```bash
+hatch run lint
+```
+
+### Publish a new version
+
+You can bump the version, create a commit and associated tag with one command:
+
+```bash
+hatch version patch
+```
+
+```bash
+hatch version minor
+```
+
+```bash
+hatch version major
+```
+
+Your default Git text editor will open so you can add information about the release.
+
+When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
+
+## Serve the documentation
+
+You can serve the Mkdocs documentation with:
+
+```bash
+hatch run docs-serve
+```
+
+It'll automatically watch for changes in your code.
+
+## License
+
+This project is licensed under the terms of the Apache Software License 2.0.

s3func-0.1.0/README.md

@@ -0,0 +1,73 @@
+# s3func
+
+<p align="center">
+    <em>Simple functions for working with S3</em>
+</p>
+
+[![build](https://github.com/mullenkamp/s3func/workflows/Build/badge.svg)](https://github.com/mullenkamp/s3func/actions)
+[![codecov](https://codecov.io/gh/mullenkamp/s3func/branch/master/graph/badge.svg)](https://codecov.io/gh/mullenkamp/s3func)
+[![PyPI version](https://badge.fury.io/py/s3func.svg)](https://badge.fury.io/py/s3func)
+
+---
+
+**Documentation**: <a href="https://mullenkamp.github.io/s3func/" target="_blank">https://mullenkamp.github.io/s3func/</a>
+
+**Source Code**: <a href="https://github.com/mullenkamp/s3func" target="_blank">https://github.com/mullenkamp/s3func</a>
+
+---
+
+## Development
+
+### Setup environment
+
+We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+hatch run test
+```
+
+### Format the code
+
+Execute the following command to apply linting and check typing:
+
+```bash
+hatch run lint
+```
+
+### Publish a new version
+
+You can bump the version, create a commit and associated tag with one command:
+
+```bash
+hatch version patch
+```
+
+```bash
+hatch version minor
+```
+
+```bash
+hatch version major
+```
+
+Your default Git text editor will open so you can add information about the release.
+
+When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
+
+## Serve the documentation
+
+You can serve the Mkdocs documentation with:
+
+```bash
+hatch run docs-serve
+```
+
+It'll automatically watch for changes in your code.
+
+## License
+
+This project is licensed under the terms of the Apache Software License 2.0.

s3func-0.1.0/pyproject.toml

@@ -0,0 +1,183 @@
+[project]
+name = "s3func"
+authors = [
+  { name = "s3func", email = "mullenkamp1@gmail.com" }
+]
+description = "Simple functions for working with S3"
+readme = "README.md"
+dynamic = ["version"]
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+]
+requires-python = ">=3.9"
+dependencies = ['boto3',
+                'urllib3',
+                'pydantic'
+]
+
+# [tool.ruff]
+# target-version = "py310"
+# extend-select = ["I", "TRY", "UP"]
+
+# [tool.pytest.ini_options]
+# addopts = "--cov=s3func/ --cov-report=term-missing"
+
+
+[tool.hatch]
+
+[tool.hatch.version]
+path = "s3func/__init__.py"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+# [tool.hatch.version]
+# source = "regex_commit"
+# commit_extra_args = ["-e"]
+# path = "s3func/__init__.py"
+
+[tool.hatch.envs.default]
+python = "3.10"
+dependencies = [
+    "spyder-kernels==2.4",
+    "black",
+    "mypy",
+    "ruff",
+    "pytest",
+    "pytest-cov",
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    
+]
+
+[[tool.hatch.envs.all.matrix]]
+python = ['3.8', '3.9', '3.10']
+
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "black>=23.1.0",
+  "mypy>=1.0.0",
+  "ruff>=0.0.243",
+]
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {args:src/s3func tests}"
+style = [
+  "ruff {args:.}",
+  "black --check --diff {args:.}",
+]
+fmt = [
+  "black {args:.}",
+  "ruff --fix {args:.}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+docs-serve = "mkdocs serve"
+docs-build = "mkdocs build"
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+select = [
+  "A",
+  "ARG",
+  "B",
+  "C",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
+]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+  # Ignore complexity
+  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["s3func"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]
+
+[tool.coverage.run]
+source_pkgs = ["s3func", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/s3func/__about__.py",
+]
+
+[tool.coverage.paths]
+s3func = ["src/s3func", "*/s3func/src/s3func"]
+tests = ["tests", "*/s3func/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[build-system]
+requires = ["hatchling", "hatch-regex-commit"]
+build-backend = "hatchling.build"
+
+[project.urls]
+Documentation = "https://mullenkamp.github.io/s3func/"
+Source = "https://github.com/mullenkamp/s3func"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/s3func",
+]

s3func-0.1.0/s3func/__init__.py

@@ -0,0 +1,5 @@
+"""Simple functions for working with S3"""
+from s3func.main import s3_client, url_session, url_to_stream, base_url_to_stream, get_object, get_object_combo, put_object, list_objects, list_object_versions, delete_objects, put_object_legal_hold, put_object_lock_configuration, get_object_legal_hold
+from s3func import utils
+
+__version__ = '0.1.0'