tern-tools / tern-rest-api Goto Github PK

Enabling the Github Pages for the tern-tools/tern-rest-api will give the user our Rest API Documentation access.

An example is available in http://kairo.eti.br/tern-rest-api/

This can be simply enabled by following the steps: github.com/tern-tools/tern-rest-api > settings > pages > 'select folder docs/'

The current PR #3 has the tests and instructions for updating the documentation.

The cache directory can be retrieved from tern using tern.utils.rootfs.get_working_directory(). You may also want to add a note in the README about setting the TERN_DEFAULT_REGISTRY value when not working with the docker container.

Originally posted by @nishakm in #3 (comment)

Optimizing the Dockerfile to reduce the current image size is still possible.
It is possible to clean up and create one or two-stage to reduce the final image size.

Add the make reformat and improve the documentation about the shortcuts in the README.md.

This issue aims to introduce the make reformat to run the linting tools in the source code, improving the development experience.
The README.md doesn't have much information about the Makefile shortcuts, which will also improve the development experience.

We should implement the Github Action to test the Docker Image build.
A new .github/workflows/ could be added to try the Docker Image Build. Should any PR trigger it?

Later, depending on the trigger (new tag release, for example), could upload the Docker Image to the Docker Hub.

I'm having trouble installing tern and tern-rest-api in the same development environment. The problem seems to be the requirements.txt and requirements-dev.txt files that constrain the installation. I find that specifying just the direct dependencies for tern-rest-api (in this case - just flask-restx resolves the problem. I am more familiar with piptools than pipenv, and I like the dev/release balance there. My suggestion would be to migrate pipenv to piptools.

This issue lists the relevant issues for the first functional version:

It is open for discussion and follow-up.

• #3
• #11
• #12
• #8
• #7
• #6

Create a Docker README to be used for users that will use the Docker Container directly.

This documentation should follow the README standards used by other Docker images giving examples of how to run, available environment variables, etc.

Implement docs/architecture.md documentation and move the design flow from README.md
The idea is to share details about the design implementation for contributors.

Relates to issue tern-tools/tern#1112 and super issue tern-tools/tern#1110

The task is to create an API Design Doc.

This issue aims to replace the setup.py with pyproject. toml to have a centralized Python Package Metadata.