release: prepare v0.1 release

Author: ernestoarbitrio

Makefile

@@ -0,0 +1,45 @@
+MAKE   = make
+PYTHON = python
+SETUP  = $(PYTHON) ./setup.py
+
+.PHONY: clean cleandocs coverage dist docs opendocs unit-coverage upload help
+
+help:
+	@echo "Usage: \`make <target>' where <target> is one or more of"
+	@echo "  clean          delete intermediate work product and start fresh"
+	@echo "  cleandocs      delete cached HTML documentation and start fresh"
+	@echo "  coverage       report overall test coverage"
+	@echo "  docs           build HTML documentation using Sphinx (incremental)"
+	@echo "  opendocs       open local HTML documentation in browser"
+	@echo "  dist           generate source and wheel distribution into dist/"
+	@echo "  unit-coverage  report unit test coverage"
+	@echo "  upload         upload distribution to PyPI"
+
+clean:
+	find . -type f -name \*.pyc -exec rm {} \;
+	find . -type f -name .DS_Store -exec rm {} \;
+	rm -rf dist .coverage
+
+cleandocs:
+	$(MAKE) -C docs clean
+
+coverage:
+	pytest --cov-report term-missing --cov=src --cov=tests
+
+dist:
+	rm -rf dist/
+	$(SETUP) sdist bdist_wheel
+
+docs:
+	$(MAKE) -C docs html
+
+opendocs:
+	open docs/_build/html/index.html
+
+unit-coverage:
+	pytest --cov-report term-missing --cov=src tests/unit
+
+upload:
+	rm -rf dist/
+	$(SETUP) sdist bdist_wheel
+	twine upload dist/*

README.md

@@ -9,4 +9,24 @@ The GDC API drives the GDC Data and Submission Portals and provides programmatic
 
 ## Features implemented
 - Downloading a Single File using GET 
-- Downloading Multiple Files using POST
+- Downloading Multiple Files using POST
+
+## Usage
+
+### Installation
+`pip install gdc-api-wrapper`
+
+### Download single file
+```python
+from gdcapiwrapper.data import Data
+Data.download(uuid="uuid-file-you-wanna-download", path="/local/path", name="filename")
+```
+NOTE: `path` and `name` are optional, by default path is your current directory and if name is 
+not provided it will be saved with the UUID as filname.
+
+### Download multiple files
+```python
+from gdcapiwrapper.data import Data
+Data.download_multiple(uuid_list=["UUID1", "UUID2", "UUID3"], path="/local/path")
+```
+NOTE: `path` is optional, by default path is your current directory.

src/gdcapiwrapper/__init__.py

@@ -3,7 +3,7 @@
 import os
 import requests
 
-__version__ = "0.1b"
+__version__ = "0.1"
 GDC_API_TOKEN = os.environ.get("GCC_API_TOKEN", None)
 GDC_API_BASE_URL = os.environ.get("GDC_API_BASE_URL", "https://api.gdc.cancer.gov/")