Skip to content

fixed text README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 10, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
josemoracard authored Mar 20, 2024
commit e0c63f3cfcc8196dc43fbef03be78a37a854797e
35 changes: 14 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,33 @@ By <a href="https://twitter.com/alesanchezr">@alesanchezr</a> and <a href="https
<!-- endhide -->


In this series you will Learn HTTP and how to use the Python Requests package to create HTTP Requests GET, POST, PUT, DELETE. The entire tutorial is πŸ‘† interactive, βœ… auto-graded and with. πŸ“Ή video tutorials.
In this series you will Learn HTTP (*Hypertext Transfer Protocol*) and how to use the Python **requests package** to create HTTP requests GET, POST, PUT, DELETE.

These exercises were built in collaboration, we need you! If you find any bugs or misspells plese contribute and report them.
The entire tutorial is πŸ‘† interactive, βœ… auto-graded and with πŸ“Ή video tutorials.

These exercises were built in collaboration, we need you! If you find any bugs or misspells, please contribute and report them.

<!-- hide -->
## One click installation (recommended):

You can open these exercises in just a few seconds by clicking: [Open in Codespaces](https://codespaces.new/?repo=4GeeksAcademy/python-http-requests-api-tutorial-exercises) (recommended) or [Open in Gitpod](https://gitpod.io#https://github.com/4GeeksAcademy/python-http-requests-api-tutorial-exercises).

> Once you have VSCode open the LearnPack exercises should start automatically. If exercises don't run automatically you can try typing on your terminal: `$ learnpack start`
> Once you have VSCode open, the LearnPack exercises should start automatically. If the exercises don't run automatically, you can try typing on your terminal: `$ learnpack start`

## Local Installation

Clone the repository in your local environment and follow the steps below:

1. Install learnpack, the package manager for learning tutorials and the html compiler plugin for learnpack, make sure you also have node.js 14+:
1. Make sure you install [LearnPack](https://www.learnpack.co/), node.js version 14+, and Python version 3+. This is the command to install LearnPack:

```
```bash
$ npm i learnpack -g
$ learnpack plugins:install learnpack-python
```

2. Download this particular exercise using learnpack and `cd` into the folder:

```
$ learnpack download python-http-requests-api-tutorial-exercises
$ cd python-http-requests-api-tutorial-exercises
```

> Note: Once you finish downloading, you will find a "exercises" folder that contains all the exercises within.

3. Start the tutorial/exercises by running the following command at the same level were your bc.json file is:
2. Start the tutorial/exercises by running the following command at the same level your `learn.json` file is:

```sh
```bash
$ pip install pytest==4.4.2 mock pytest-testdox
$ learnpack start
```
Expand All @@ -54,16 +47,16 @@ Each exercise is a small react application containing the following files:
2. **README.md:** contains exercise instructions.
3. **test.py:** you don't have to open this file, it contains the testing script for the exercise.

> Note: The exercises have automatic grading but its very rigid and string, my recomendation is to ignore the tests and use them only as a recomendation or you can get frustrated.
> Note: The exercises have automatic grading, but it's very rigid and strict, my recommendation is to not take the tests too serious and use them only as a suggestion, or you may get frustrated.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

1. [Alejandro Sanchez (alesanchezr)](https://github.com/alesanchezr), contribution: (coder) πŸ’» (idea) πŸ€”, (build-tests) ⚠️ , (pull-request-review) πŸ‘€ (build-tutorial) βœ… (documentation) πŸ“–
1. [Alejandro Sanchez (alesanchezr)](https://github.com/alesanchezr), contribution: (coder) πŸ’», (idea) πŸ€”, (build-tests) ⚠️, (pull-request-review) πŸ‘€, (build-tutorial) βœ…, (documentation) πŸ“–

2. [Paolo (plucodev)](https://github.com/plucodev), contribution: (bug reports) πŸ›, contribution: (coder), (translation) 🌎
2. [Paolo (plucodev)](https://github.com/plucodev), contribution: (bug reports) πŸ›, contribution: (coder) πŸ’», (translation) 🌎

This project follows the[all-contributors](https://github.com/kentcdodds/all-contributors) specification.Contributions of any kind are welcome!
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!

This and many other exercises are built by students as part of the 4Geeks Academy [Coding Bootcamp](https://4geeksacademy.com/us/coding-bootcamp) by [Alejandro SΓ‘nchez](https://twitter.com/alesanchezr) and many other contributors. Find out more about our [Full Stack Developer Course](https://4geeksacademy.com/us/coding-bootcamps/part-time-full-stack-developer), and [Data Science Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning).
This and many other exercises are built by students as part of the 4Geeks Academy [Coding Bootcamp](https://4geeksacademy.com/us/coding-bootcamp) by [Alejandro SΓ‘nchez](https://twitter.com/alesanchezr) and many other contributors. Find out more about our [Full Stack Developer Course](https://4geeksacademy.com/us/coding-bootcamps/part-time-full-stack-developer), and [Data Science Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning).