https://github.com/roadsideseb/click-example
The Click example that I use in my tutorial articles.
https://github.com/roadsideseb/click-example
Last synced: 4 months ago
JSON representation
The Click example that I use in my tutorial articles.
- Host: GitHub
- URL: https://github.com/roadsideseb/click-example
- Owner: roadsideseb
- License: mit
- Created: 2017-12-26T15:58:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-23T20:03:42.000Z (almost 7 years ago)
- Last Synced: 2024-08-13T07:07:56.346Z (8 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 12
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - roadsideseb/click-example - The Click example that I use in my tutorial articles. (Python)
README
# Click Tutorial Example
This repo contains the Click example that I'm using throughout my written tutorials. You can check out the different stages of the tutorial by checking out the corresponding branches. `master` will always contain the latest, most complete version of the example.
## Getting Started
You can easily get started with this example by cloning this repository and installing the dependencies. My recommendation would be to do that in a virtual environment. You can find out more [on virtual environment in the official documentation for Python](https://docs.python.org/3/tutorial/venv.html).
This example **requires Python 3.6**. That means you can use the built-in virtual environment module `venv` that comes with Python 3.6.
Here's what the setup of this project looks like starting from scratch:
```sh
# Clone the Github repo
$ git clone [email protected]:elbaschid/click-example.git
# Change into the project directory
$ cd click-example
# Create a virtual environment with Python 3
$ python3 -m venv ./venv
# Activate the virtual environment
$ source ./venv/
# Install the required packages
(venv) $ pip install -r requirements.txt
```
## Contributions
I'm only human, which means I make mistakes. If you find anything that doesn't work or think you can phrase things clearer, feel free to **open an issue**. Or if you have the skills to fix it, **fork the repo** and **open a pull request** with your suggested changes.
I appreciate any constructive input 😍.
# License
This project is licensed under the [MIT license](./LICENSE). Basically, you can do whatever you want with it 💖.