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

Scripts to streamline docker installation and execution #6016

Closed

Conversation

phbrgnomo
Copy link

Pull Request OpenBB

The OpenBBTerminal

Pull Request for the OpenBBTerminal

Description

Two bash scripts were added to make it easier to run OpenBBTerminal from Linux command line:

docker-install
Streamline the building and container creation pulling the proper docker-compose files.
It also creates one single container, and make it persistent, instead of creating multiple containers every time the Terminal is started from the command line

docker-run
Attach the existing terminal to the current CLI.

Documentation also changed with instructions on how to use the scripts.

  • Summary of the change/ bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

Tested on my local machine. Scripts worked fine.
Note to the need of changing permissions of both the scripts and the folders created when the containers are being built (.openbbterminal/ an OpenBBTerminal)

Note: This is a common issue i experience (and have seen around). The container image do not set the proper permissions for these folders, and the error `PermissionError: [Errno 13] Permission denied: '/home/python/OpenBBUserData/styles'` always happen the first time the container is built
  • Ensure the affected commands still execute in the OpenBB Terminal.
  • Ensure the Platform (previously named SDK) is working as intended.
  • Check any related reports.

Checklist

  • I ensure I have self-reviewed my code.
  • I have commented/documented my code, particularly in hard-to-understand sections.
  • I have adhered to the GitFlow naming convention and my branch name is in the format of feature/feature-name or hotfix/hotfix-name.
  • Update our documentation following these guidelines. Update any user guides that are affected by the changes.
  • Update our tests following these guidelines.
  • Make sure you are following our CONTRIBUTING guidelines.
  • If a feature was added make sure to add it to the corresponding integration test script.

The OpenBB Platform

Pull Request for the OpenBB Platform

Description

  • Summary of the change/ bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.

  • Please provide instructions so we can reproduce.

  • Please also list any relevant details for your test configuration.

  • Ensure all unit and integration tests pass.

  • If you modified/added command(s):

    • Ensure the command(s) execute with the expected output.
      • API.
      • Python Interface.
    • If applicable, please add new tests for the command (see CONTRIBUTING.md to leverage semi-automated testing).
  • If a new provider was introduced or a new fetcher was added to an existing provider:

    • Ensure the existing tests pass.
    • Ensure the new provider and/or fetcher is stable and usable.
    • If applicable, please add new tests for the provider and/or fetcher (see CONTRIBUTING.md to leverage semi-automated testing).
  • If a new provider or extension was added:

Checklist

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have adhered to the GitFlow naming convention and my branch name is in the format of feature/feature-name or hotfix/hotfix-name.
  • I ensure that I am following the CONTRIBUTING guidelines.

@CLAassistant
Copy link

CLAassistant commented Jan 31, 2024

CLA assistant check
All committers have signed the CLA.

@deeleeramone deeleeramone added the docker Docker-related work label Jan 31, 2024
@phbrgnomo phbrgnomo closed this Jan 31, 2024
@phbrgnomo
Copy link
Author

After some more testing, the scrips where failing to do what they were intending to do.

I am still having some issues running the command to pull the image.

Will create new scripts to pull the repo and build the image locally.

1 similar comment
@phbrgnomo
Copy link
Author

After some more testing, the scrips where failing to do what they were intending to do.

I am still having some issues running the command to pull the image.

Will create new scripts to pull the repo and build the image locally.

@hjoaquim
Copy link
Contributor

hjoaquim commented Feb 1, 2024

I see you've opened #6020 and are iterating with @piiq there.
Thanks, @phbrgnomo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Docker-related work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants