search

jeafreezy / nigeria_geodata

Fast and efficient access to geospatial data for Nigeria.
https://jeafreezy.github.io/nigeria_geodata
MIT License
5 stars 1 forks source link

Road to Public Release #2

Open jeafreezy opened 4 months ago

jeafreezy commented 4 months ago

Below are what I feel we should do before we release the package to the public.

Aesthetics

Functionalities

Deployment

Development After the initial release, we will need to discuss how to handle future releases. E.g PR, branching etc.

Versioning

We can follow SEMVER for this. Will need to research more on it, but it will help us to key into the industry practice.

Promotion Any or all of the following.

Some of these might not be necessary for beta, but if we can get them done, it'll be great, plus it can also act as a guide.

Let me know what you think @SammyGIS .

SammyGIS commented 4 months ago

Below are what I feel we should do before we release the package to the public.

Aesthetics

  • [ ] Update the ReadMe with more information and examples.
  • [ ] Update the LICENSE.
  • [ ] Update the Contributions.
  • [ ] Write documentations
  • [ ] Setup documentation deployment CI-CD (GitHub Actions).
  • [ ] Clean up the codebase and write docstrings for necessary functions and classes.
  • [ ] Create a logo for the library.

Functionalities

  • [ ] A user can search for data using the library and preview it as a Dataframe or a table in their console
  • [ ] A user can download data using the library to at least 2 formats (GeoJSON, Esri Shapefile)
  • [ ] A user can filter/query data to their area of interest by bbox or state name.
  • [ ] A user can preview these data on an interactive map in jupyter notebook.
  • [ ] Sync and async support
  • [ ] CLI support

Deployment

  • A CI-CD that deploys the package to PyPi

Development After the initial release, we will need to discuss how to handle future releases. E.g PR, branching etc.

Versioning

We can follow SEMVER for this. Will need to research more on it, but it will help us to key into the industry practice.

Promotion Any or all of the following.

  • [ ] YouTube Video.
  • [ ] LinkedIn Post.
  • [ ] Articles.
  • [ ] Sharing to local communities.

Some of these might not be necessary for beta, but if we can get them done, it'll be great, plus it can also act as a guide.

Let me know what you think @SammyGIS .

Yes this is great, I am going to create a PR and start working on some of this as we go on.