Skip to content
This repository was archived by the owner on Oct 1, 2025. It is now read-only.
rapha-pereiraPublic archive

About

An Python API to access SIGAA through HTTP Requests.

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

⚠️ Discontinued project (read-only repo.)

This repository was archived after Cloudflare Turnstile was implemented in SIGAA, making it difficult to scrape the website.

sigaa_api

The SIGAA API is a RESTful API that allows you to access the SIGAA platform through HTTP requests, returning the data as a JSON.

This API was developed using Python and FastAPI, and it is hosted on Google Cloud Run.

⭐ Accessing the API

The API is hosted on Google Cloud Run and can be accessed through the following link:

https://sigaa-api-service-7tggr7zpeq-uc.a.run.app

📖 Usage

The API has it's own generated docs on the following link:

https://sigaa-api-service-7tggr7zpeq-uc.a.run.app/docs

https://sigaa-api-service-7tggr7zpeq-uc.a.run.app/redoc

📚 Contributing

Contributing to this project is simple, just follow the steps below:

  1. Fork the project
  2. Create your virtual environment with: (poetry install --no-root)
  3. Create a new branch (git checkout -b feature)
  4. Test your changes with: (make run-dev), your server will be running on your localhost
  5. Commit your changes (git commit -m 'Add feature')
  6. Push to the branch (git push origin feature)
  7. Create a pull request :)

🔄 Future releases

  • Activities endpoint.

Made with ❤️ by Raphael P. Gomes

About

An Python API to access SIGAA through HTTP Requests.

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages