Skip to content

Commit bc635a9

Browse files
Michael JohnsonMichael Johnson
authored andcommitted
removing reference to bitbucket and replacing it with github. Adding example of Dockerfile using requirements.txt file
1 parent 9badee6 commit bc635a9

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,24 @@ create new extractors.
1212

1313
## Setup
1414

15+
Install using pip (for most recent versions see: https://pypi.org/project/pyclowder/):
16+
17+
```
18+
pip install pyclowder==2.4.0
19+
```
20+
1521
Install pyClowder on your system by cloning this repo:
1622

1723
```
18-
git clone https://opensource.ncsa.illinois.edu/bitbucket/scm/cats/pyclowder.git
24+
git clone https://github.com/clowder-framework/pyclowder.git
1925
cd pyclowder
2026
pip install -r requirements.txt
2127
python setup.py install
28+
2229
```
23-
or directly from Bitbucket:
30+
or directly from GitHub:
2431
```
25-
pip install -r https://opensource.ncsa.illinois.edu/bitbucket/projects/CATS/repos/pyclowder/raw/requirements.txt git+https://opensource.ncsa.illinois.edu/bitbucket/scm/cats/pyclowder.git
32+
pip install -r https://raw.githubusercontent.com/clowder-framework/pyclowder/master/requirements.txt git+https://github.com/clowder-framework/pyclowder.git
2633
```
2734

2835
## Example Extractor
@@ -224,6 +231,29 @@ the docker container.
224231
If you need any python packages installed you will need to create file called requiremenets.txt. If this file exists
225232
the docker build process will use `pip install -r requirements.txt` to install these packages.
226233

234+
To use the latest version of pyClowder we recommend choosing a base image of your choice and install pyClowder by adding it to the requirements.txt file. An example Dockerfile is below:
235+
236+
```
237+
# Base image
238+
FROM ubuntu:20.04
239+
240+
# Creating workdir
241+
WORKDIR /home/clowder
242+
243+
# Adding necessary code to container under workdir
244+
COPY <MY.CODE>.py extractor_info.json /home/clowder/
245+
246+
# Install pip
247+
RUN apt-get update && \
248+
apt-get install -y python3-pip
249+
250+
# Install pyClowder and any other python dependencies
251+
COPY requirements.txt .
252+
RUN pip3 install -r requirements.txt
253+
254+
# Command to be run when container is run
255+
CMD python3 <MY.CODE>.py
256+
```
227257
## SimpleExtractor
228258
Motivation: design and implement a simple extractor to bridge Python developer and knowledge of PyClowder library. It requires little effort for Python developers to wrap their python code into Clowder's extractors.
229259

0 commit comments

Comments
 (0)