Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Main Workflow

on:
push:
branches: [ main ]
branches: [ staging ]
pull_request:
workflow_dispatch:
inputs:
Expand All @@ -22,4 +22,7 @@ jobs:
uses: ./.github/workflows/test.yml
with:
python-version: ${{ inputs.python-version || '3.11' }}
permissions:
id-token: write
contents: read
secrets: inherit
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This library provides an S3 client that supports client-side encryption.
### Prerequisites

- Python 3.11 or higher
- [Poetry](https://python-poetry.org/) for dependency management
- [uv](https://github.com/astral-sh/uv) for package and project management

### Setup

Expand Down Expand Up @@ -73,3 +73,13 @@ Common Flake8 issues in the codebase include:
- **Code complexity** (C901): Refactor complex functions

When contributing to this project, please try to fix linting issues in the files you modify.

### Pull Request Command
While this project is in development,
it is useful to use `gh pr` to create the pull-requests,
so they can be associated with the GitHub project.

```sh
gh pr create -B staging -p "S3EC-Python" -f
```

6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ test = [
"pytest>=8.4.1",
]
dev = [
"black>=24.3.0",
# black >= 26 requires a reformat

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather just reformat than pin an older dependency, especially while we have relatively small codebase.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

discussed offline, @texastony will do this in a follow-up PR

"black>=24.3.0,<26.0.0",
"ruff>=0.3.0",
]

Expand Down Expand Up @@ -52,3 +53,6 @@ max-complexity = 10

[tool.ruff.lint.isort]
known-first-party = ["s3_encryption"]

[tool.ruff.lint.per-file-ignores]
"test/**/*.py" = ["D100", "D101", "D102", "D103", "D104", "E501"]
Comment on lines +57 to +58

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generated by the kiro-cli!!!
I am in the FUTURE!