You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-13
Original file line number
Diff line number
Diff line change
@@ -71,29 +71,21 @@ Using `Python>=3.8`, install dependencies with `pip install -r requirements.txt`
71
71
See [http://localhost:8000/docs](http://localhost:8000/docs) for auto-generated Swagger API documentation.
72
72
73
73
## Quick start using open pharamacy location data on local development server
74
-
1.) Set up a postgresql instance with PostGIS
74
+
1. Set up a postgresql instance with PostGIS
75
75
76
-
2.) Perform installation as indicated in *"Installation"* section.
76
+
2. Perform installation as indicated in *"Installation"* section.
77
77
78
-
3.) Download Rx Open's pharacy location database from https://rxopen.org/api/v1/map/download/facility and place the resulting `facility.csv` in the project's root folder.
78
+
3. Download Rx Open's pharacy location database from https://rxopen.org/api/v1/map/download/facility and place the resulting `facility.csv` in the project's root folder.
79
79
80
-
4.) Execute `python import-pharmacies.py`
80
+
4. Execute `python import-pharmacies.py`
81
81
82
-
5.) Run development server, as indicated in *"Running"* section.
82
+
5. Run development server, as indicated in *"Running"* section.
83
83
84
84
You should now be able to issue http requests using the API endpoints against the local server, such as `http://localhost:8000/nearest/100/pharmacies/to/75001`
85
85
86
86
## Running in Azure
87
87
This software can run in an Azure App Service with the custom startup command `python -m uvicorn main:app --host 0.0.0.0`
88
88
89
-
## Roadmap
90
-
-[X] Initial API implementation
91
-
-[X] Sample upload script
92
-
-[ ] Builtin support for pagination
93
-
-[ ] administration features for "neighbor" data
94
-
-[ ] more robust logging options
95
-
-[ ] Add parameter for GPS coordinates as location to get results within
96
-
97
89
## Credits
98
90
99
91
A special thanks goes to [Matt McInerney](http://pixelspread.com/) for freely sharing his futuristic Orbitron font.
0 commit comments