Skip to content

Latest commit

 

History

History
139 lines (103 loc) · 7.52 KB

README.md

File metadata and controls

139 lines (103 loc) · 7.52 KB
Raw

Operation Code Learning Resources API

Vision

This project provides an API for storing and retrieving learning resources that might be helpful to members of Operation Code. Ideally, this project will provide the backend for various interfaces for working with the data. The front end can be found at https://operationcode.org/resources.

Getting Started

Sometimes these installs can be tricky. If you get stuck ask for help in the Slack #oc-python-projects channel!

  1. If you are not a member of Operation Code, please sign up at https://operationcode.org/join

    • Provide your email, name, zip code, and a password of your choosing.
    • You will need this email and password later when creating your API key.
    • Look for a Slack invite email and join the Slack organization, and then the #oc-python-projects channel.

  2. Install Git.

    • Choose your OS from the website and follow the prompts. This installs Git and the Bash Terminal on your machine.
    • Windows users: use the Git Bash Terminal for any of the commands in the remainder of this README. The Bash Primer
    • Extra: Git Documentation for more information on Git.

  3. Fork & Clone

  4. Install Docker and ensure it is running

  5. Install Make if you're on Windows. OSX already has it installed. Linux will tell you how to install it (i.e., sudo apt-get install make)

  6. Run make setup

  7. Run make all and then navigate to http://localhost:5000/

This should open the Operation Code Resources API webpage which has the documentation for the API. You can go through it to know about all available endpoints and understand how to use them.

If you encounter any errors, please open an issue or contact us on slack in #oc-python-projects.

Authentication

Routes that modify the database (e.g., POST and PUT) are authenticated routes. You need to include a header in your request with your API key. To generate an API key:

  1. Send a POST to http://localhost:5000/api/v1/apikey with the following JSON payload:

    {
  "email": "[email protected]",
  "password": "yoursupersecretpassword"
}

    The email and password specified should be your login credentials for the Operation Code website. If you are not a member of Operation Code, please sign up at https://operationcode.org/join

    Example curl command:

    curl -X POST \
  http://localhost:5000/api/v1/apikey \
  -H 'Content-Type: application/json' \
  -d '{
        "email": "[email protected]",
        "password": "yoursupersecretpassword"
      }'

  2. The response will have the following structure (but will contain your email and apikey):

    {
    "apiVersion": "1.0",
    "data": {
        "apikey": "yourapikey",
        "email": "[email protected]"
    },
    "status": "ok"
}
    • It may be helpful to save this apikey in a secure place like a password manager.
    • Do not hard-code your apikey in your own scripts. Always use an environment variable
    • You can always re-issue the POST to recover your apikey.
    • To rotate your apikey (getting a new apikey and making your old key invalid), issue an empty POST request to /api/v1/apikey/rotate with your apikey included in a header x-apikey: yourapikey: 
      curl -X POST \
  http://localhost:5000/api/v1/apikey/rotate \
  -H 'x-apikey: 0a14f702da134390ae43f3639686fe26'

  3. When you create a request to an authenticated route, you must include a header x-apikey: yourapikey

    Example curl request to an authenticated route:

    curl -X POST \
  http://localhost:5000/api/v1/resources \
  -H 'Content-Type: application/json' \
  -H 'x-apikey: 0a14f702da134390ae43f3639686fe26' \
  -d '{
        "category": "Regular Expressions",
        "languages": ["Regex"],
        "name": "Regex101",
        "notes": "Regular Expression tester",
        "paid": false,
        "url": "https://regex101.com/"
}'

Development Notes

If you make changes to the models.py or other schemas, you need to run a migration and upgrade again:

make migrate

Before committing, please lint your code:

make lint

And make sure the tests pass:

make test

There are many more make commands available you may find useful.

History

This project began when I (Aaron Suarez) started to learn software development. I did a little searching for learning resources and started a list of resources I wanted to come back to when I had some time. Shortly after this, I joined Operation Code and encountered several more learning resources that members were sharing. Soon enough, my list had grown to about 40 links. At some point, someone asked "Hey, does anyone have any learning resources?" and I said "I have a list of about 40 links that I can DM to you if you like."

Immediately, I received several requests from others asking for this list. I started to share it around via DMs, and someone suggested that I put it up on GitHub. I also got a lot of feedback about how it would be nice if there was more metadata, like a way to categorize the resources, organize them by language, and maybe even have some notes or a description (assuming the title isn't obvious). Meanwhile, the list continued to grow rapidly.

Someone got the bright idea to put it on the OC website, so I started working on a PR to incorporate it into OC, which at the time used Rails and YAML files to serve up list-like content. However, a redesign of the site was in progress, so my PR was never merged. Eventually I got out of the military and began doing software development full time. I kept maintaining the list as a little side project and sharing it around, but it hasn't made it onto the OC website. However, the resources.yml file is accessible via Slack with a slash command, so if you type /repeat resources in a public channel, the bot will link you to that file.

Eventually, the idea to use the data for multiple purposes was proposed. One really cool idea was for a Slack bot to ping relevant channels with random resources on a regular basis so that people could find awesome resources that had been shared without having to find them by searching the slack history. So it was decided that a full featured API would be important in order to really serve the needs of the OC community. This repo contains the source for the aforementioned API.

It took a lot of time and collaborative effort to put together the data and to build the API, and the work is not done yet! Please help us out, and feel free to use the learning resources to gain the knowledge required to contribute.