Comments (6)
It got really hectic and I got pulled away from the laptop...will get back to it on my own when I have a chance, unless someone else gets to it first.
FastAPI auto-generated docs sound awesome!
from covid-api.
Suggestion: 2 documentation.
One with the explanation about what it is and how to use -> Handwritten
One with the api about how the single endpoint work -> Autogen
In this way you have a HOW TO USE it or a generic explanation about this project and HOW THIS SINGLE ENDPOINT WORK that explain the single point and it's all time describing the code without human help
from covid-api.
In this way we can use the handwritten docs as a path. If you have a beacon or a path is easer to develop code and a easy to use endpoint
from covid-api.
Markdown is fine! I've no direct experience in auto generating the docs and pushing to ReadTheDocs but I imagine it's possible through some API integration.
If you are also interested in API docs, FastAPI auto generates it.
p.s: PyBeachLA sounds cool! Let me check how to make you admin of this project. I trust you if you need to add other people to the project.
from covid-api.
Sounds good, I'll work on getting this started before the sprinters arrive.
from covid-api.
Yes, we can have both. The auto generated one will need some "help" from our side (we need to add some documentation and docstrings to the methods) but it's self maintaining. The other one will be the one we host in the static pages of the project. I think we can use mkdocs and generate something like FastAPI one https://fastapi.tiangolo.com
from covid-api.
Related Issues (20)
- Some related projects HOT 4
- Patterns of Enterprise Application Architecture HOT 3
- Empty json HOT 8
- Covid-API MVP HOT 15
- Make the root URL do something useful HOT 2
- Implement a proper import script for the data
- Create a production app on Heroku HOT 9
- How do we handle different data formats? HOT 5
- Cannot run tests with pytest anymore
- Ignore site-packages when running pytest HOT 1
- Deploy to Heroku when tests pass in CircleCI
- Add --all and --latest to import script
- Refactor the code to support additional sources of data
- Add query string support for /v1/jh/daily-reports endpoint
- Add standardised country code HOT 2
- Add Italian Protezione Civile data source
- Directory structure HOT 4
- Add report date to JH import
- Global testing dataset from OWID
- Is the date of the file needed? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from covid-api.