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.4.0.tar.gz (277.0 kB view details)

Uploaded Source

Built Distribution

s3func-0.4.0-py3-none-any.whl (275.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: s3func-0.4.0.tar.gz
  • Upload date:
  • Size: 277.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for s3func-0.4.0.tar.gz
Algorithm Hash digest
SHA256 769851f1b8eb28fec48106420f19742b1a54573134d40139aae88fd1c3592312
MD5 fb86cf5a6b0628d73a91421298cbd309
BLAKE2b-256 99b49a2d83eff2f46f14bd502e4c47c6033e5b265133999f50a33350cead0031

See more details on using hashes here.

File details

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

File metadata

  • Download URL: s3func-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 275.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for s3func-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f901de4e4c8c1ea4f12321f0dc90d99797eb82c660c5274502c888f3feaad9a
MD5 76709b723364c40b61d70fda0260f232
BLAKE2b-256 caa13d31de9ff4ffa64ec55eb559d5903cf2d3bee053aabae3a5b743f360dd3a

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