Skip to main content

Simple functions for working with S3

Project description

s3func

Simple functions for working with S3

build codecov PyPI version


Documentation: https://mullenkamp.github.io/s3func/

Source Code: https://github.com/mullenkamp/s3func


Development

Setup environment

We use Hatch 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:

hatch run test

Format the code

Execute the following command to apply linting and check typing:

hatch run lint

Publish a new version

You can bump the version, create a commit and associated tag with one command:

hatch version patch
hatch version minor
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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

s3func-0.5.4.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

s3func-0.5.4-py3-none-any.whl (283.7 kB view details)

Uploaded Python 3

File details

Details for the file s3func-0.5.4.tar.gz.

File metadata

  • Download URL: s3func-0.5.4.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.26.0

File hashes

Hashes for s3func-0.5.4.tar.gz
Algorithm Hash digest
SHA256 8f74bcd4538154fcbf49868764b66e133d6ecc2a28a294c9681d22b7b65f0306
MD5 4de6610250554c5247b8ae32b0f79968
BLAKE2b-256 073f62e0d701db8940074cc91c9e578793c42a55ad5c2e672134659de635bc0c

See more details on using hashes here.

File details

Details for the file s3func-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: s3func-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 283.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.26.0

File hashes

Hashes for s3func-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a69aceb072b94b1c15bbaa96c2b6ebffad145da4bbf91293c6c6f2c7f7397279
MD5 19acaa235e1f340896e18118ac36817f
BLAKE2b-256 acfaf5e935f8e6fb7df12926f5bc764745191fd9c15bacaecf871d210cebd55e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page