Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2 create package structure for first draft #3

Merged
merged 37 commits into from
Feb 23, 2024

Conversation

ClaasRostock
Copy link
Collaborator

No description provided.

…PythonPath. This is no longer necessary. Installing the current package in "editable" mode, using the pip install -e option, solves the issue and removes the need to manually add /src to the PythonPath environment variable.
…t package in "editable" mode, using the pip install -e option.

This removes the need to manually add /src to the PythonPath environment variable in order for debugging and tests to work.
… schemata. The json files are now indented, hence easier to read by humans.
@ClaasRostock ClaasRostock linked an issue Feb 22, 2024 that may be closed by this pull request
8 tasks
@ClaasRostock
Copy link
Collaborator Author

@StanleyYoo @tomarnepedersen @davidhjp01 @minhemdnv

Hi Stanley, Tom Arne, David and Minos,
Could you review this first working version of the maritime-schema package?

If you want to install the maritime-schema package as a dependency into any other project, you can already do so by using maritime-schema==0.0.3b3 as version specifier. E.g.

pip install maritime-schema==0.0.3b3

The documentation is published here:
https://dnv-opensource.github.io/maritime-schema/README.html

I was able to tie in the html docs from the schema into the Sphinx documentation, so that both the Python API and the JSON schemata are in the same documentation.

The html pages of schema documentation are maybe not perfectly rendered / beautiful yet. With a bit of research (html and ccs and that stuff is not exactly my expertise, happy for any support), I am sure we can visually pimp it.

Most importantly, though; Let us make sure the package works at first as you expect.

Copy link
Contributor

@StanleyYoo StanleyYoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my end, it works. it needs to be applied to affected repos, e.g. caga-communicator and caga-evaluator.

@minhemdnv minhemdnv merged commit 3e86989 into main Feb 23, 2024
14 checks passed
@minhemdnv minhemdnv deleted the 2-create-package-structure-for-first-draft branch February 23, 2024 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create package structure for first draft
3 participants