Skip to content

Commit

Permalink
docs: enhance contents
Browse files Browse the repository at this point in the history
  • Loading branch information
silverwestK committed Jan 7, 2024
1 parent f4aa41c commit ca85af6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
</p>

Welcome to "My Little Monorepo with Pants" -
This repository contains an example of a monorepo with Python which utilizes a powerful tool, called [Pants](https://github.com/pantsbuild/pants). Feel free to explore, experiment, and adapt the practices demonstrated here to meet your specific development needs. Whether you're new to monorepos or Pants, this repository aims to be a valuable resource for enhancing your development workflow. 🚀✨
This repository contains an example of a monorepo with Python which utilizes a powerful tool, called [Pants](https://www.pantsbuild.org/). Feel free to explore, experiment, and adapt the practices demonstrated here to meet your specific development needs. Whether you're new to monorepos or Pants, this repository aims to be a valuable resource for enhancing your development workflow. 🚀✨

## Repository Highlights
* **Pants**: This repository is built on the _**Pants**_ build system. It not only utilizes Pants for code execution but also for various tasks like code formatting, linting, and testing. Additionally, Pants is employed for building and pushing container images (with Docker), as well as managing dependencies.
* **Pants**: This repository is built on the _**Pants**_ build system. It not only utilizes Pants for code execution but also for various tasks like code formatting, linting, and testing. Additionally, Pants is employed for building and pushing container images (with [Docker](https://docs.docker.com/), as well as managing dependencies.

* **Simple API Example**: Explore a straightforward CRUD API implemented with [FastAPI](https://github.com/tiangolo/fastapi). This example can be instrumental in understanding Python monorepo concepts.
* **Automated Build**: A streamlined continuous integration (CI) and continuous delivery (CD) process is in place, automated through [GitHub Actions](https://docs.github.com/en/actions).
Expand Down Expand Up @@ -87,3 +87,5 @@ This repository contains an example of a monorepo with Python which utilizes a p
* https://www.pantsbuild.org/
* https://github.com/pantsbuild/actions
* https://github.com/pantsbuild/example-python
* https://blog.pantsbuild.org/pants-pex-and-docker/
* https://blog.pantsbuild.org/optimizing-python-docker-deploys-using-pants/

0 comments on commit ca85af6

Please sign in to comment.