This is a patient service api that will save and retrieve patient details.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
This is a Python-based RESTful API that is part of the Hospital Management System.
Setting up your project locally. To get a local copy up and running follow these simple example steps.
Required software and how to install them.
- python
- MacOS: follow this guide - https://docs.python-guide.org/starting/install3/osx/
-
New repository setup
- Fork the Project (from the github website)
- Clone the forked repo locally
git clone [email protected]:YOUR_USERNAME/PATIENT_SERVICE_API.git
- List the current configured remote repository for your fork. It should show only the forked version of the repository that you have just forked.
$ git remote -v > origin [email protected]:YOUR_USERNAME/PATIENT_SERVICE_API.git (fetch) > origin [email protected]:YOUR_USERNAME/PATIENT_SERVICE_API.git (push)-
Specify a new remote upstream repository that will be synced with the fork. NOTE: This will be the original owner - the se-2024/PATIENT_SERVICE_API repo:
git remote add upstream https://github.com/se-2024/PATIENT_SERVICE_API.git -
List out the remotes and this time you will have another remote:
$ git remote -v origin [email protected]:fbatroni/PATIENT_SERVICE_API.git (fetch) origin [email protected]:fbatroni/PATIENT_SERVICE_API.git (push) upstream [email protected]:se-2024/PATIENT_SERVICE_API.git (fetch) upstream [email protected]:se-2024/PATIENT_SERVICE_API.git (push) -
Existing repository setup
NOTE: You already have a PATIENT_SERVICE_API repo and you'd like to reset your existing repo to mirror the se-2024/PATIENT_SERVICE_API repo. These steps will result in resetting the existing code and any changes will be lost.- List the current configured remote repository for your repo. You should only have one that points to your repository hosted under your github username.
$ git remote -v > origin [email protected]:YOUR_USERNAME/PATIENT_SERVICE_API.git (fetch) > origin [email protected]:YOUR_USERNAME/PATIENT_SERVICE_API.git (push)
If you have another remote you can delete it. The only other remote you will need will be the upstream to the shared repository. 2. Specify a new remote upstream repository that will be synced with your repo. NOTE: This will be the original owner - the se-2024/PATIENT_SERVICE_API repo:
git remote add upstream https://github.com/se-2024/PATIENT_SERVICE_API.git- List out the remotes and this time you will have another remote:
$ git remote -v origin [email protected]:fbatroni/PATIENT_SERVICE_API.git (fetch) origin [email protected]:fbatroni/PATIENT_SERVICE_API.git (push) upstream [email protected]:se-2024/PATIENT_SERVICE_API.git (fetch) upstream [email protected]:se-2024/PATIENT_SERVICE_API.git (push)-
Reset your local main branch to match the remote upstream
git reset --hard upstream/main -
Force push these changes to your repository so that all code is mirrored. This is a one-time operation.
git push origin main -f
Enumerating objects: 27, done. Counting objects: 100% (27/27), done. Delta compression using up to 8 threads Compressing objects: 100% (21/21), done. Writing objects: 100% (27/27), 144.44 KiB | 10.32 MiB/s, done. Total 27 (delta 0), reused 2 (delta 0), pack-reused 0 To github.com:fbatroni/PATIENT_SERVICE_API.git + e0fc073...0be4789 main -> main (forced update)
- pre-commit - Git hook scripts that are useful for identifying simple issues before submission to code review.
- Code linting
- Flake8 - A linter tool that checks your code for style and syntax errors
- Code formatting
- Black - A Python code formatter that automatically formats your code according to a set of predefined rules
- isort - A Python utility/library to sort imports alphabetically, and automatically separated into sections and by type
- By using Flake8 and Black, you can ensure good quality of your Python code.
Useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
pytest framework - a Python testing framework that can be used to write various types of software tests, including unit tests, integration tests, end-to-end tests, and functional tests pytest-sqlalchemy-mock - pytest fixtures to create an in-memory DB instance on tests and dump your raw test data
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
(Assuming you've followed the steps in "Installation" section):
- Fetch the latest from the upstream repository
git fetch upstream
remote: Enumerating objects: 27, done.
remote: Counting objects: 100% (27/27), done.
remote: Compressing objects: 100% (21/21), done.
remote: Total 27 (delta 0), reused 27 (delta 0), pack-reused 0
Unpacking objects: 100% (27/27), 144.42 KiB | 1.60 MiB/s, done.
From github.com:se-2024/PATIENT_SERVICE_API
* [new branch] main -> upstream/main- Check out your fork's local default branch - in this case, we use main.
- Merge the latest code from the upstream main branch into your local main
git merge upstream/main - Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request