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

Uploaded Source

Built Distribution

s3func-0.5.9-py3-none-any.whl (284.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: s3func-0.5.9.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.9.tar.gz
Algorithm Hash digest
SHA256 8586827dee02719f070f0a6bf20c2ace7f27ad773cf0b5671adb7fbaad6d9866
MD5 16c6d7c8e2d995ba8be28d0c6fe1297a
BLAKE2b-256 2cb49ff9f5afea6742c69591911681e2627ea18adba6071698b86c2a39fc2866

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for s3func-0.5.9-py3-none-any.whl
Algorithm Hash digest
SHA256 799a133587928d14f5aff504597385651edc08d75aaa7e2f4c972910c1e3e428
MD5 06596251ff71f6e9f7ae5b2a640c8225
BLAKE2b-256 f9979b3f8619a7c801c5e220f879ccb6070f9e7a0ab1faf610332301711aebbc

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