From 8b5b5ed49c371b1eabb67fb16a7ef3ee30aec266 Mon Sep 17 00:00:00 2001 From: Abhishek A B Date: Wed, 10 May 2023 14:10:09 +0530 Subject: [PATCH 1/4] Updated Docker Documentation on Readme --- .idea/.gitignore | 5 +++++ .idea/modules.xml | 8 ++++++++ .idea/vcs.xml | 6 ++++++ .idea/vrs-python.iml | 12 ++++++++++++ README.md | 30 ++++++++++++++++++++++++++++++ 5 files changed, 61 insertions(+) create mode 100644 .idea/.gitignore create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml create mode 100644 .idea/vrs-python.iml diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 00000000..b58b603f --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 00000000..18cd9150 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 00000000..35eb1ddf --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/vrs-python.iml b/.idea/vrs-python.iml new file mode 100644 index 00000000..0c8867d7 --- /dev/null +++ b/.idea/vrs-python.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 538dd7d5..076d8b84 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,36 @@ gracefully (and without causing problems for others!).** The `[extras]` argument tells pip to install packages to fullfill the dependencies of the `ga4gh.vrs.extras` package. +## Getting started with Docker + +Docker is an open-source platform that enables you to automate the deployment and management of applications using containers. Containers are lightweight, isolated environments that package all the necessary software and dependencies for an application to run consistently across different systems + +If you're new to Docker, follow these steps to get started: + +### Step 1: Install Docker +To begin, you need to install Docker on your machine. Follow the official Docker installation guide for your specific operating system: + +[Docker Installation Guide](https://docs.docker.com/get-docker/) + +### Step 2: Verify Docker Installation +Once Docker is installed, you can verify the installation by running the following command in your terminal: + + +``` docker version ``` + +This command displays the Docker client and server versions, indicating that Docker is successfully installed on your machine. + +### Step 3: Run a Docker Container +To test Docker, let's run a simple container. In your terminal, execute the following command: + +``` docker run hello-world ``` + +This command pulls the hello-world Docker image (if not already present) and runs it in a container. You should see a message confirming that Docker is working correctly. + +[Docker Documentation](https://docs.docker.com/) + + + ## Installing dependencies for ga4gh.vrs.extras The `ga4gh.vrs.extras` modules are not part of the VR spec per se. They are From 1c7fa442137cd8ae3b3e5d87594b1d79347dbcd1 Mon Sep 17 00:00:00 2001 From: Abhishek A B Date: Wed, 10 May 2023 23:33:11 +0530 Subject: [PATCH 2/4] fixes documentation --- .gitignore | 3 ++- README.md | 11 +++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index cb2a21d6..5d11e3cd 100644 --- a/.gitignore +++ b/.gitignore @@ -21,4 +21,5 @@ venv lint uta_*.pgd.gz .vscode -*.log \ No newline at end of file +*.log +.idea \ No newline at end of file diff --git a/README.md b/README.md index 076d8b84..70a604a1 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ gracefully (and without causing problems for others!).** The `[extras]` argument tells pip to install packages to fullfill the dependencies of the `ga4gh.vrs.extras` package. -## Getting started with Docker +## Installing dependencies for ga4gh.vrs.extras + +Note : The ga4gh.vrs.extras package used in this project has dependencies on services like *SeqRepo*. To simplify the setup process and ensure consistency across different environments, **Docker** is used to manage these dependencies. Docker allows you to package the required services and their configurations into containers, making it easier to deploy and run them on any system. -Docker is an open-source platform that enables you to automate the deployment and management of applications using containers. Containers are lightweight, isolated environments that package all the necessary software and dependencies for an application to run consistently across different systems -If you're new to Docker, follow these steps to get started: -### Step 1: Install Docker +#### Step 1: Install Docker To begin, you need to install Docker on your machine. Follow the official Docker installation guide for your specific operating system: [Docker Installation Guide](https://docs.docker.com/get-docker/) @@ -74,11 +74,10 @@ To test Docker, let's run a simple container. In your terminal, execute the foll This command pulls the hello-world Docker image (if not already present) and runs it in a container. You should see a message confirming that Docker is working correctly. -[Docker Documentation](https://docs.docker.com/) +[Refer Documentation](https://docs.docker.com/) -## Installing dependencies for ga4gh.vrs.extras The `ga4gh.vrs.extras` modules are not part of the VR spec per se. They are bundled with ga4gh.vrs for development and installation convenience. These From e728f58af340116c438b6a605bcdbcbc6736ca08 Mon Sep 17 00:00:00 2001 From: Abhishek A B Date: Wed, 10 May 2023 23:36:12 +0530 Subject: [PATCH 3/4] remove .idea --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 5d11e3cd..adf964d3 100644 --- a/.gitignore +++ b/.gitignore @@ -22,4 +22,4 @@ lint uta_*.pgd.gz .vscode *.log -.idea \ No newline at end of file +.idea/ \ No newline at end of file From 62845f8c234bcea9d4042ac6d0594be948da1144 Mon Sep 17 00:00:00 2001 From: Abhishek A B Date: Wed, 10 May 2023 23:37:31 +0530 Subject: [PATCH 4/4] remove .idea --- .idea/.gitignore | 5 ----- .idea/modules.xml | 8 -------- .idea/vcs.xml | 6 ------ .idea/vrs-python.iml | 12 ------------ 4 files changed, 31 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/modules.xml delete mode 100644 .idea/vcs.xml delete mode 100644 .idea/vrs-python.iml diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index b58b603f..00000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 18cd9150..00000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1ddf..00000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/vrs-python.iml b/.idea/vrs-python.iml deleted file mode 100644 index 0c8867d7..00000000 --- a/.idea/vrs-python.iml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file