Commit ad5fcd61 authored by Grant, Josh's avatar Grant, Josh
Browse files

Merge branch 'readme_and_docker_changes' into 'develop' 

update dev.Dockerfile and README

See merge request !35
parents 4cdc6cb4 04515893

Dockerfile

+2 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ COPY src/ tmp/src 




RUN set -eux && pip install --upgrade pip && \

      cd /tmp/src/ && c && \

      cd /tmp/src/ && pip install -e .[all] && \

      pip install pytest pytest-cov 

      

CMD ['sh', 'tail', '-f', '/dev/null']
 
CMD ["tail", "-f", "/dev/null"]

Pipfile

+1 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ name = "pypi" 


[packages]

common = {editable = true, directory = "./src"}

twine = "*"



[dev-packages]

pytest = "*"

Pipfile.lock

+337 −67

File changed.

Preview size limit exceeded, changes collapsed.

dev.Dockerfile

0 → 100644
+9 −0
Original line number Diff line number Diff line 
FROM --platform=linux/amd64 python:3.11-slim

ARG GITLAB_TOKEN=3t2LFTptHcudHsKRsgr8

ARG COMMON_VERSION=0.3.1



RUN apt-get -yqq update && apt-get install -yqq postgresql-client



RUN pip install common-package[all]==$COMMON_VERSION --index-url https://__token__:$GITLAB_TOKEN@code.ornl.gov/api/v4/projects/10568/packages/pypi/simple



CMD ["tail", "-f", "/dev/null"]
 
 No newline at end of file

src/README.md

+19 −0
Original line number Diff line number Diff line 
# Common Package



## Installation

This package can be installed on its own, but also offers optional extras for users who need additional functionality related to PostgreSQL, MSSQL, and web scraping tools.

Basic Installation



To install the basic package without extras, run the following command:



```bash

pip install common-package

```

You can install any combination of these extras by specifying them in brackets, using the following syntax:



```bash

pip install common-package[postgres,mssql,scrapers]

```

Alternatively, if you want to include all available extras, you can use:



```bash

pip install common-package[all]

```

## Scripts



Contains a script for testing the connection to a database `test-db-conn`