Skip to content
Closed
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
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,3 +384,22 @@ The `standard` extra dependencies are `rich` and `shellingham`.
## License

This project is licensed under the terms of the MIT license.

## Contributing

We welcome contributions of all kinds (\*v*) :
1) Documentation improvements - good for beginners
2) Bug fixes - AFTER GAINING EXPERIENCE AND LEARNING CODEBASE ONLY :)
3) New features - Same as above
4) Tests - Always welcome (\*v*)
5) Typo fixes - Show your english mastery (._.)

### Development Setup
1. Fork the repository
2. Create a virtual environment
3. Merge your changes if accepted (:

### Pull Request Guidelines
Keep PRs focused
Add tests for new features
Update documentation if behavior changes ( otherwise you can face linting issues (;;))
14 changes: 14 additions & 0 deletions docs/help-typer.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,20 @@ There you could buy me a coffee ☕️ to say thanks. 😄

As you have seen in the documentation, Typer is built on top of Click.

## Relationship between Typer and Click

Typer is built on top of Click. Click handles most command line behavior,
including parsing commands and generating help output.

Typer uses Python type hints and function signatures to create Click
commands automatically. Internally, Typer turns functions into Click
objects and relies on Click to run commands and display help text.

In most cases, you do not need to work with Click directly. Typer
provides a simpler interface based on Python types, while still allowing
the use of Click features when more control is needed.


You can also sponsor:

* Pallets Project (Click maintainers) <a href="https://palletsprojects.com/donate" class="external-link" target="_blank">via the PSF</a> or <a href="https://tidelift.com/subscription/pkg/pypi-click" class="external-link" target="_blank">via Tidelift</a>
Expand Down
21 changes: 20 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<style>
.md-content .md-typeset h1 { display: none; }
.md-content .md-typeset h1 { display: none; }
</style>

<p align="center">
Expand Down Expand Up @@ -387,6 +387,25 @@ The `standard` extra dependencies are `rich` and `shellingham`.

**Note**: The `typer` command is only included in the `typer` package.

## Contributing

We welcome contributions of all kinds (\*v*) :
1) Documentation improvements - good for beginners
2) Bug fixes - AFTER GAINING EXPERIENCE AND LEARNING CODEBASE ONLY :)
3) New features - Same as above
4) Tests - Always welcome (\*v*)
5) Typo fixes - Show your english mastery (._.)

### Development Setup
1. Fork the repository
2. Create a virtual environment
3. Merge your changes if accepted (:

### Pull Request Guidelines
Keep PRs focused
Add tests for new features
Update documentation if behavior changes ( otherwise you can face linting issues (;;))

## License

This project is licensed under the terms of the MIT license.
Loading