s3func


Names3func JSON
Version 0.7.2 PyPI version JSON
download
home_pageNone
SummarySimple functions for working with S3
upload_time2025-07-12 07:31:11
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # s3func

<p align="center">
    <em>Simple functions for working with S3</em>
</p>

[![build](https://github.com/mullenkamp/s3func/workflows/Build/badge.svg)](https://github.com/mullenkamp/s3func/actions)
[![codecov](https://codecov.io/gh/mullenkamp/s3func/branch/master/graph/badge.svg)](https://codecov.io/gh/mullenkamp/s3func)
[![PyPI version](https://badge.fury.io/py/s3func.svg)](https://badge.fury.io/py/s3func)

---

**Documentation**: <a href="https://mullenkamp.github.io/s3func/" target="_blank">https://mullenkamp.github.io/s3func/</a>

**Source Code**: <a href="https://github.com/mullenkamp/s3func" target="_blank">https://github.com/mullenkamp/s3func</a>

---

## Development

### Setup environment

We use [Hatch](https://hatch.pypa.io/latest/install/) 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:

```bash
hatch run test
```

### Format the code

Execute the following command to apply linting and check typing:

```bash
hatch run lint
```

### Publish a new version

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

```bash
hatch version patch
```

```bash
hatch version minor
```

```bash
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:

```bash
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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "s3func",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Mike Kittridge <mullenkamp1@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1a/8d/8c250dd462a14b43c13052cbb04687a26b6965a3a3eedc990affd7061edb/s3func-0.7.2.tar.gz",
    "platform": null,
    "description": "# s3func\n\n<p align=\"center\">\n    <em>Simple functions for working with S3</em>\n</p>\n\n[![build](https://github.com/mullenkamp/s3func/workflows/Build/badge.svg)](https://github.com/mullenkamp/s3func/actions)\n[![codecov](https://codecov.io/gh/mullenkamp/s3func/branch/master/graph/badge.svg)](https://codecov.io/gh/mullenkamp/s3func)\n[![PyPI version](https://badge.fury.io/py/s3func.svg)](https://badge.fury.io/py/s3func)\n\n---\n\n**Documentation**: <a href=\"https://mullenkamp.github.io/s3func/\" target=\"_blank\">https://mullenkamp.github.io/s3func/</a>\n\n**Source Code**: <a href=\"https://github.com/mullenkamp/s3func\" target=\"_blank\">https://github.com/mullenkamp/s3func</a>\n\n---\n\n## Development\n\n### Setup environment\n\nWe use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.\n\n### Run unit tests\n\nYou can run all the tests with:\n\n```bash\nhatch run test\n```\n\n### Format the code\n\nExecute the following command to apply linting and check typing:\n\n```bash\nhatch run lint\n```\n\n### Publish a new version\n\nYou can bump the version, create a commit and associated tag with one command:\n\n```bash\nhatch version patch\n```\n\n```bash\nhatch version minor\n```\n\n```bash\nhatch version major\n```\n\nYour default Git text editor will open so you can add information about the release.\n\nWhen you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.\n\n## Serve the documentation\n\nYou can serve the Mkdocs documentation with:\n\n```bash\nhatch run docs-serve\n```\n\nIt'll automatically watch for changes in your code.\n\n## License\n\nThis project is licensed under the terms of the Apache Software License 2.0.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Simple functions for working with S3",
    "version": "0.7.2",
    "project_urls": {
        "Documentation": "https://mullenkamp.github.io/s3func/",
        "Source": "https://github.com/mullenkamp/s3func"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a693ddf6e7054992be2bf7a3d0e3c069d0a44a6363620f2a1e99a80e969121ea",
                "md5": "5d674b90f52511c0ebf36398bda4d897",
                "sha256": "9a7164c866ca64448995fd83792122bd851065115d992fa13c39b6722db78dfa"
            },
            "downloads": -1,
            "filename": "s3func-0.7.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5d674b90f52511c0ebf36398bda4d897",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 27655,
            "upload_time": "2025-07-12T07:31:10",
            "upload_time_iso_8601": "2025-07-12T07:31:10.205493Z",
            "url": "https://files.pythonhosted.org/packages/a6/93/ddf6e7054992be2bf7a3d0e3c069d0a44a6363620f2a1e99a80e969121ea/s3func-0.7.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1a8d8c250dd462a14b43c13052cbb04687a26b6965a3a3eedc990affd7061edb",
                "md5": "a0ee22347bd56ea2ad18b95a2ed1c40b",
                "sha256": "9502358587018f2d6a78bfd55d7931a6c59a6f08513f28d546ea813d85ab22ac"
            },
            "downloads": -1,
            "filename": "s3func-0.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a0ee22347bd56ea2ad18b95a2ed1c40b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 24905,
            "upload_time": "2025-07-12T07:31:11",
            "upload_time_iso_8601": "2025-07-12T07:31:11.659183Z",
            "url": "https://files.pythonhosted.org/packages/1a/8d/8c250dd462a14b43c13052cbb04687a26b6965a3a3eedc990affd7061edb/s3func-0.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-12 07:31:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mullenkamp",
    "github_project": "s3func",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "s3func"
}
        
Elapsed time: 1.07899s