You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@baremaps.apache.org by Bertil Chapuis <bc...@gmail.com> on 2022/10/27 08:56:06 UTC
Project structure and submodules
Hello Everyone,
The structure of the project in terms of submodules is overly complex and some names are confusing (e.g. baremaps-database, baremaps-postgres). Also, as we start doing releases, having a lot of submodules published on the maven repository may complicate things when searching for artifacts. I guess the structure of the project is one of the pains encountered by new comers and simplifying it may help.
Here is a proposal for a revised structure and I would love to discuss it:
- baremaps-benchmarks
- baremaps-cli
- baremaps-engine (single module with subpackages?)
- org.apache.baremaps.collection
- org.apache.baremaps.geocoder
- org.apache.baremaps.iploc
- org.apache.baremaps.osm
- org.apache.baremaps.postgres (to be merged with org.apache.baremaps.database?)
- org.apache.baremaps.storage (to be renamed formats or codec?)
- org.apache.baremaps.stream (utilities to deal with large streams)
- org.apache.baremaps.workflow
- baremaps-http (to be renamed server?)
- baremaps-testing
Should we take care of this before the first release?
Best,
Bertil
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@baremaps.apache.org
For additional commands, e-mail: dev-help@baremaps.apache.org
Re: Project structure and submodules
Posted by Bertil Chapuis <bc...@gmail.com>.
> On 27 Oct 2022, at 15:22, Josh Fischer <jo...@joshfischer.io> wrote:
>
>> Should we take care of this before the first release?
>
> Will this new structure require a significant amount of effort? How
> will the steps to create a release change? Do you see any issues
> coming from the project structure change?
Effort wise (1-2 hours), it is mainly a matter of merging pom files, the package structure will essentially remain the same. As the non-java dependencies (lmdb, rocksdb) have been removed and the codebase is rather small, I don’t see major issues related to this change.
Re: Project structure and submodules
Posted by Josh Fischer <jo...@joshfischer.io>.
inlined.
On Thu, Oct 27, 2022 at 3:56 AM Bertil Chapuis <bc...@gmail.com> wrote:
>
> Hello Everyone,
>
> The structure of the project in terms of submodules is overly complex and some names are confusing (e.g. baremaps-database, baremaps-postgres). Also, as we start doing releases, having a lot of submodules published on the maven repository may complicate things when searching for artifacts. I guess the structure of the project is one of the pains encountered by new comers and simplifying it may help.
>
> Here is a proposal for a revised structure and I would love to discuss it:
Keeping in mind I probably have the least knowledge about the code base.
> - baremaps-benchmarks
> - baremaps-cli
> - baremaps-engine (single module with subpackages?)
> - org.apache.baremaps.collection
> - org.apache.baremaps.geocoder
> - org.apache.baremaps.iploc
> - org.apache.baremaps.osm
> - org.apache.baremaps.postgres (to be merged with org.apache.baremaps.database?)
> - org.apache.baremaps.storage (to be renamed formats or codec?)
> - org.apache.baremaps.stream (utilities to deal with large streams)
> - org.apache.baremaps.workflow
> - baremaps-http (to be renamed server?)
+1 remaining barmeps-http to baremaps-servers seems to be more self explanatory.
> - baremaps-testing
+1. I like the new structure you are proposing as the baremaps-engine.
it seems to simplify management and distribution of artifacts.
> Should we take care of this before the first release?
Will this new structure require a significant amount of effort? How
will the steps to create a release change? Do you see any issues
coming from the project structure change?
>
> Best,
>
> Bertil
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@baremaps.apache.org
> For additional commands, e-mail: dev-help@baremaps.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@baremaps.apache.org
For additional commands, e-mail: dev-help@baremaps.apache.org
Re: Project structure and submodules
Posted by Léonard Besseau <l....@gmail.com>.
>
> Here is a proposal for a revised structure and I would love to discuss it:
>
+ 1 for revising the structure.
> - baremaps-benchmarks
> - baremaps-cli
> - baremaps-engine (single module with subpackages?)
> - org.apache.baremaps.collection
> - org.apache.baremaps.geocoder
> - org.apache.baremaps.iploc
> - org.apache.baremaps.osm
> - org.apache.baremaps.postgres (to be merged with
> org.apache.baremaps.database?)
> - org.apache.baremaps.storage (to be renamed formats or codec?)
> - org.apache.baremaps.stream (utilities to deal with large streams)
> - org.apache.baremaps.workflow
> - baremaps-http (to be renamed server?)
> - baremaps-testing
>
+1 for merging org.apache.baremaps.postgres and
org.apache.baremaps.database, I think it would make sense as there is
already postgres specific code in the database package.
Do we intend to support another kind of DB in the future? It could change
how we want to organize this.
For the org.apache.baremaps.storage renaming, either is fine for me.