Skip to content

Commit b8af108

Browse files
committed
Update setup.py and README for upload to PyPI
1 parent 0b1b312 commit b8af108

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,23 @@ Have any questions? Please [open an issue](https://github.com/htem/FANC_auto_rec
1010

1111
As is always the case in python, consider making a virtual environment (using your preference of virtualenv/virtualenvwrapper or conda) before installing.
1212

13-
### Installation option 1: pip install directly from GitHub
13+
### Installation option 1: pip install from PyPI
14+
15+
pip install fanc-fly
16+
17+
### Installation option 2: pip install directly from GitHub
18+
The code on GitHub will sometimes be slightly more up to date than the version on PyPI
1419

1520
pip install git+https://github.com/htem/FANC_auto_recon.git
1621

17-
### Installation option 2: Clone then install
22+
### Installation option 3: Clone then install
23+
This is the best option if you want to make changes yourself to the code
1824

1925
cd ~/repos # or wherever you keep your repos
2026
git clone https://github.com/htem/FANC_auto_recon.git
2127
cd FANC_auto_recon
2228
pip install -e .
2329

24-
2530
### Provide credentials
2631

2732
Access to the latest reconstruction of FANC is restricted to authorized users. If you are a member of the FANC community (see [Collaborative community](../../wiki#collaborative-community) on this repo's wiki) and have been granted access, you can generate an API key by visiting [https://global.daf-apis.com/auth/api/v1/create_token](https://global.daf-apis.com/auth/api/v1/create_token) and logging in with your FANC-authorized google account. Copy the key that is displayed, then run the following commands in python to save your key to the appropriate file:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
requirements = [l for l in requirements if not l.startswith('#')]
99

1010
setuptools.setup(
11-
name='fanc',
11+
name='fanc-fly',
1212
version='2.0.0',
1313
author='Jasper Phelps',
1414
author_email='jasper.s.phelps@gmail.com',

0 commit comments

Comments
 (0)