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
64 changes: 34 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ Python as a network service.
```
.
├── cmd
│   └── fhttp - Example a Function using the http middleware
│   └── fhttp - Example Function using the http middleware
│   └── fce - Example Function using the CloudEvent middleware
├── src/func_python
│   ├── http.py - HTTP Middleware
│   ├── http.py - HTTP Middleware
│   ├── cloudevents.py - CloudEvent Middleware
├── tests
│   ├── http_test.py - HTTP Middleware tests
└── README.md - This Readme
│   ├── http_test.py - HTTP Middleware tests
│   ├── cloudevent_test.py - CloudEvent tests
└── README.md - This Readme
```

## Development
Expand All @@ -25,7 +28,7 @@ Run suite:
To enable more granular log levels:
`poetry run pytest --log-cli-level=INFO`

## Example Main
## Example Commands

Minimal example of running the test command, which shows how this
library is used when integrate with Functions, and can be useful during dev.
Expand Down Expand Up @@ -63,6 +66,32 @@ p. From a personal fork, create a new worktree for the bug, feature or chore

8. (optional) pull into local fork's main and push to remote fork main.

## Testing

To run the package level tests

To test if the package published to Test PyPI works, ensure the
project has it added as an explicit source in pyproject.toml:
```
[[tool.poetry.source]]
name = "test-pypi"
url = "https://test.pypi.org/simple/"
priority = "explicit"
```
Then update the dependency to explicitly pull the new version which is only
available on TestPyPI. For example to test a hypothetical unreleased version
0.1.2:
```
[tool.poetry.dependencies]
func_python = {version = "0.1.2", source = "test-pypi"}
```
Run `poetry install` to install the unreleased version from Test PyPI

Note: do not check in this change.




## Releasing

NOTE: This process is currently undergoing minor tweaks, and thus contains
Expand Down Expand Up @@ -99,31 +128,6 @@ automated.

10. Update the GitHub release's notes to be the changelog section's contents .

## Testing

To run the package level tests

To test if the package published to Test PyPI works, ensure the
project has it added as an explicit source in pyproject.toml:
```
[[tool.poetry.source]]
name = "test-pypi"
url = "https://test.pypi.org/simple/"
priority = "explicit"
```
Then update the dependency to explicitly pull the new version which is only
available on TestPyPI. For example to test a hypothetical unreleased version
0.1.2:
```
[tool.poetry.dependencies]
func_python = {version = "0.1.2", source = "test-pypi"}
```
Run `poetry install` to install the unreleased version from Test PyPI

Note: do not check in this change.




### Potential improvements

Expand Down
60 changes: 57 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ repository = "https://github.com/knative-extensions/func-python"
[tool.poetry.dependencies]
python = "^3.12"
hypercorn = "^0.17.3"
cloudevents = "^1.11.0"

[tool.pytest.ini_options]
pythonpath = ["src"]
Expand Down
Loading
Loading