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

Uploaded Source

Built Distribution

s3func-0.5.11-py3-none-any.whl (284.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for s3func-0.5.11.tar.gz
Algorithm Hash digest
SHA256 4f91d0010533901db05bc1254697b2b0dfe831791c9682ed95efec55dd6267f4
MD5 16600ffd95438fdc7c04470a736ff9ff
BLAKE2b-256 5ae05370dddf09561e2dbbdb1edf2f9e6d841e7ed0cf9f2cdbf4e87c16c5af1c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for s3func-0.5.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e825ad91633034c31df94761d8e604db35e028bf922299b1b4a53e57cb3886a9
MD5 fb89ca29a252a00118064d9c6ab2b345
BLAKE2b-256 d7d21d30c548409ed5da916ca896a8e633a5bb331d9cddad500eb0ff9e215d35

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