search

cividi / frictionless-geojson

An Frictionless Framework extension to add GeoJSON read and write support.
https://pypi.org/project/frictionless-geojson/
MIT License
5 stars 1 forks source link

Upgrade to latest frictionless framework #5

Open ChasNelson1990 opened 1 year ago

ChasNelson1990 commented 1 year ago

Dear @n0rdlicht and @cividi team,

Thanks for your work on this plugin. I work with a team @fjelltopp on a variety of projects and we needed to add geoJSON file support to our CKAN using @frictionlessdata ckanext-validation and, of course, the frictionless framework.

Sadly your current codebase doesn't work out of the box with the latest framework (v5.13.1) and so I have essentially rewritten your plugin based on the latest frictionless approaches and version.

You can find the code in our fork of your repo here: https://github.com/fjelltopp/frictionless-geojson/tree/frictionlessv5

For now I have essentially created an entirely separate plugin that satisfies our requirements (we are not geospatial experts so things like WKT-specifics don't matter for our use case). But it seems a real shame to have two different packages that each work for different versions of frictionless and also do slightly different things.

So, how would you and your team feel about working together on this. There are three ways I could see this going:

  1. You don't use this package anymore, don't mind what happens and would be willing to hand over the pypi package to us - we could publish our fork to pypi and maintain it for the community.
  2. You use this package but would be willing to see it updated for the latest frictionless framework. You would like to maintain ownership of the pypi package but are happy to work with us to merge our fork back into this repository - we can then work together to maintain it for the community.
  3. You use this package as is and do not want it to change (totally understandable). We agree to maintain two distinct packages; however, to make life easier for the community we rename our repos: frictionless4-geojson and frictionless5-geojson (or something like that) and we both host our modules on pypi and support our own communities.

Just to say, whichever route works for you guys we would like to keep you in the authors list of our fork (and keep the fork connected) so there's transparency through to this repo - I hope that's okay?

n0rdlicht commented 1 year ago

Hi @ChasNelson1990 many thanks for reaching out. Super cool to see more geodata being used in frictionless 🎉

I can - unfortunately - confirm that this library is kind of deprecated or as you summarised unmaintained, hence I am open for any of the proposed options. I personally don't have a strong preference for any option. Being very interested in geospatial support in frictionless myself I am happy to contribute but tend to not have a lot of time on my hand to do so. Hence I think the following could be an option if it doesn't imply a whole lot of work (not too familiar with advanced pypi processes): mostly option 1. We transfer the pypi project/make you a co-owner (not sure which concepts pypi allows) so you can publish a new version while the old ones (0.0.1 and 0.0.2) stay in place. In the readme we add a note to indicate those two version are based on our repo, which we archive/make read-only and also add a note to your repo as the successor plugin. Probably there is other aspects, let me know and if you think this is workable.

ChasNelson1990 commented 1 year ago

Hey @n0rdlicht,

I think that sounds like a great way forward.

My PyPi username is ChasNelson1990, that should be enough to give me maintainer rights I think? I can then publish our version as 1.0.0.

In the meantime I will add something to our README along the lines of:

## Old Versions
This repository contains the code for frictionless-geojson v1.0.0 onwards.
v1.0.0 is compatible with frictionless framework v5 only.

If you are looking for compatibility with earlier versions of frictionless or for the code used in v0.0.1 and v0.0.2 of frictionless-geojson then please see cividi/frictionless-geojson.

Does that sound okay?

If you then add something similar to this repo and flag the repo as archived then I think we've done a good job!

And if you do, at some point in the future, get time to review v1.0.0 or suggest some changes we would love to hear them. I am not a geojson expert and so it has very much been written with the simplest understanding!

loleg commented 1 year ago

Looks like an excellent suggestion to me cc @n0rdlicht