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

Uploaded Source

Built Distribution

s3func-0.5.8-py3-none-any.whl (284.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for s3func-0.5.8.tar.gz
Algorithm Hash digest
SHA256 4aa21390d473bbed7abc8e0c9c86d5767ec27eb775269e716464a30c1d62ff6c
MD5 6c18fd5d08befa37ed394fc37b4f3aa5
BLAKE2b-256 17bcd1cf1f086ca57f56cd727220577a2ea908d546f1a3bd5b6fdc81f4b44e5b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for s3func-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6c04a8a31a2e09634179f62c408e5c68dd180da460862ecb6bb4843ebcaf0acd
MD5 f8c2e4b1d7915ae589b177bcb2f213cc
BLAKE2b-256 dfd896e767727fd314bc4fbbbb054d7f64e89223a6b558ae6fce056234c03b37

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