Welcome to the student-grades-api! This application allows you to manage student records simply and securely. With this API, you can add, view, update, or delete student data while ensuring that all information is safe and protected.
To get started, you need to download the application. You can find the latest version on our Releases page.
Visit this page to download the latest version of the student-grades-api.
Before installing, ensure your system meets the following requirements:
- Operating System: Windows, macOS, or Linux
- Python: Version 3.6 or higher
- SQLite: Built-in support (no separate installation needed)
- Internet: For API connection if using a remote database
-
Download the Application
- Go to this page.
- Click on the latest release.
- Download the installer or package suitable for your operating system.
-
Install Dependencies
-
After downloading, extract the files if necessary.
-
Open your command prompt or terminal.
-
Navigate to the folder where you downloaded the application.
-
Run the following command to install required Python packages:
pip install -r requirements.txt
-
-
Run the Application
-
In the same command prompt or terminal, start the API with the command:
python main.py -
This command will launch the API. You should see a message indicating that the server is running.
-
-
Access the API
- Open your web browser.
- Go to
http://localhost:8000/docsto view the API documentation. - Here, you can interact with the API and test different operations.
The student-grades-api provides several key features to help you manage student records. These include:
- CRUD Operations: Easily create, read, update, and delete student records.
- JWT Authentication: Secure access to your data with JSON Web Token authentication.
- Data Validation: Automatic validation of input data using Pydantic, ensuring that only correct data is processed.
- Friendly User Interface: Access a simple and intuitive interface through the documentation page.
- SQLite Storage: Utilize a lightweight library to manage your data effectively.
Before you can manage student records, you need to authenticate yourself. Here’s how you do it:
-
Create an Account
- Use the registration endpoint (found in the API documentation) to create your account.
- Fill in the required information, such as your username and password.
-
Log In
- After registering, log in using your credentials.
- The API will provide you with a token. Save this token as you will need it for subsequent requests.
-
Use the Token
- Include the token in the header of your requests to access protected areas of the API.
- Example header format:
Authorization: Bearer YOUR_TOKEN_HERE
For detailed information about each API endpoint, visit the provided documentation:
- Endpoint for creating a student
- Endpoint for retrieving student records
- Endpoint for updating a student record
- Endpoint for deleting a student
You can find all of this in the API documentation located at http://localhost:8000/docs.
If you encounter issues while using the student-grades-api, here are some common solutions:
- API Not Responding: Ensure the API is running in your command prompt or terminal.
- Failed to Authenticate: Check that you're using the correct token and that it hasn’t expired.
- Error Messages: Refer to the API documentation for explanations of error messages you receive.
If you need further assistance or want to connect with other users, consider visiting our discussion forum or join our chat group. Engaging with other users can provide insights and solutions to common challenges.
If you wish to contribute to the student-grades-api, check our guidelines in the repository. We welcome contributions to improve this API and enhance its usability.
Thanks to everyone who has contributed to this project and provided valuable feedback. Your support helps us continuously improve the student-grades-api.
For any further questions or assistance, feel free to reach out through the issues section of the repository.