Skip to content

Commit

Permalink
minor fixes/updates for PyPI upload
Browse files Browse the repository at this point in the history
  • Loading branch information
LindoNkambule committed May 11, 2022
1 parent b0ba174 commit aa6e8ce
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 29 deletions.
29 changes: 7 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,17 @@
<!-- badges: start -->
![install status](https://github.com/atgu/GWASpy/actions/workflows/install-ci.yml/badge.svg)

Genome-wide association studies pypeline (GWASpy): A Python package for performing GWAS QC, PCA, and genotype imputation.
Genome-wide association studies pypeline (GWASpy): A Python package for performing GWAS QC, PCA, haplotype phasing, and
genotype imputation.

## Installation


For now you can install GWASpy and its dependencies using the command below. In the near future, it will be uploaded to pypi

1. Install non-Python dependencies. The above command assumes the user already has [Homebrew](https://brew.sh/)
(MacOS) or [apt-get](https://linux.die.net/man/8/apt-get) (Linux) installed.

```bash
curl https://raw.githubusercontent.com/atgu/preimp_qc/main/env-setup.sh | bash
```

2. Clone the repo and install GWASpy and the required packages.
Once the package is on [pypi](https://pypi.org/), it won't be ncessary to run ``pip install -r requirements.txt``

GWASpy is available through [PyPI](https://pypi.org/project/gwaspy/). To install, run the command:
```bash
# Install preimp_qc and its dependencies
git clone https://github.com/atgu/GWASpy.git
cd GWASpy/
pip3 install -r requirements.txt
python3 setup.py sdist
pip3 install dist/GWASpy-0.1.0.tar.gz
pip3 install gwaspy
```

## Usage
For usage, please visit [GWASpy](https://gwaspy.readthedocs.io/)

For usage, please visit [GWASpy](https://gwaspy.readthedocs.io/en/latest/index.html)
## Copyright and License
GWASpy is generously distributed under the [MIT License](https://github.com/atgu/GWASpy/blob/main/LICENSE)
15 changes: 8 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
long_description = fh.read()

classifiers = [
'Development Status :: 1 - Planning',
'Development Status :: 4 - Beta',
'Environment :: Console',
'Intended Audience :: Science/Research'
'Intended Audience :: Science/Research',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.2',
Expand All @@ -22,12 +22,13 @@
'Operating System :: MacOS'
]

setup(name='GWASpy',
setup(name='gwaspy',
version='0.1.0',
author='Lindokuhle Nkambule',
author_email='lnkambul (at) broadinstitute.org',
url='https://github.com/atgu/GWASpy',
description='GWASpy: A Python package for performing GWAS QC, PCA, and genotype imputation.',
author_email='[email protected]',
url='https://gwaspy.readthedocs.io/',
project_urls={"GitHub": "https://github.com/atgu/GWASpy"},
description='GWASpy: A Python package for performing GWAS QC, PCA, phasing, and genotype imputation.',
long_description=long_description,
long_description_content_type="text/markdown",
license='MIT',
Expand All @@ -42,6 +43,6 @@
},
classifiers=classifiers,
keywords='',
install_requires=['hail', 'matplotlib', 'numpy', 'pandas', 'pylatex'],
install_requires=['hail', 'matplotlib', 'numpy', 'pandas', 'pylatex', 'plotly'],
zip_safe=False
)

0 comments on commit aa6e8ce

Please sign in to comment.