Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds clarification regarding the need to install dependencies before building #47

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,28 @@ http://fossology.github.io/atarashi

## Steps for Installation

### Installing dependencies

Dependencies are required before building Atarashi. You can install them in
following ways:

- `pip install -r requirements.txt`

OR

- `# python setup.py install_deps`

However, the dependencies are installed while installing Atarashi (running
[install command](#install))

### Build (optional)

- `$ python setup.py build`
- Install the dependencies:

`$ pip install -r requirements.txt`
- Build the package using Setuptools:

`$ python setup.py build`
- Build will generate 3 new files in your current directory
1. `data/Ngram_keywords.json`
2. `licenses/<SPDX-version>.csv`
Expand All @@ -35,11 +54,6 @@ http://fossology.github.io/atarashi

- `# python setup.py install`

### Installing just dependencies

- `pip install -r requirements.txt`


## How to run

Get the help by running `atarashi -h` or `atarashi --help`
Expand Down
6 changes: 4 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,12 @@ def run(self):
global install_options
global build_requirements
global ext_links

install_only_user = []
if os.geteuid() != 0:
install_options += ['--user']
install_only_user = ['--user']

subprocess.run(install_options + build_requirements, check = True)
subprocess.run(install_options + install_only_user + build_requirements, check = True)
for package in ext_links:
subprocess.run(install_options + ['-e', package], check = True)

Expand Down