Started defining project structure

.github/workflows/extract.yml

@@ -0,0 +1,35 @@
+name: Extract Data and Run Tests
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Download data
+        run: |
+          wget 
+      
+      - name: Install dependencies
+        run: |
+          pip install wheel setuptools
+          pip install black==22.3.0 isort==5.10.1 flake8==4.0.1
+      
+      - name: Download data
+        run: |
+          wget -P ./data/ https://apps.who.int/gho/athena/api/GHO/SA_0000001439?filter=csv
+      
+

.gitignore

@@ -0,0 +1,5 @@
+*.csv
+*.DS_Store
+*.idea/
+*.vs/
+*__pycache__/

README.md

@@ -1 +1,24 @@
-# breast-cancer-stats
+# breast-cancer-stats
+
+This repository holds source code and examples on how to extract and visualize
+breast cancer data from the World Health Organization (WHO) database.
+
+## Setup
+A python package without useful utility tools was developed to aid extraction
+and visualization. The package is compatible with `Python >= 3.8` and has the
+following dependencies:
+
+* pandas
+
+* numpy
+
+* matplotlib
+
+Start by creating a virtual environment and installing the package:
+
+```
+virtualenv -ppython3 venv --clear
+source venv/bin/activate
+python3 -m pip install who_extract@https://github.com/andreped/breast-cancer-stats.git
+```
+

assets/requirements.txt

@@ -0,0 +1,4 @@
+pandas
+numpy
+matplotlib
+setuptools

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.py

@@ -0,0 +1,36 @@
+import setuptools
+
+
+with open("README.md", "r", encoding="utf-8") as f:
+    long_description = f.read()
+
+
+setuptools.setup(
+    name="who-extract",
+    version="0.0.1",
+    author="André Pedersen",
+    author_email="[email protected]",
+    license="MIT",
+    description="Project for extraction of World Health Organization (WHO) data and visualization.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/andreped/breast-cancer-stats",
+    include_package_data=True,
+    packages=setuptools.find_packages(),
+    install_requires=[
+        "numpy",
+        "pandas",
+    ],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "Topic :: Scientific/Engineering",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent"
+    ],
+    python_requires=">=3.8",
+)