Skip to content

docs: Update docs for Windows workaround to solve databuilder extras_require error. #1861

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 17, 2022
Merged

docs: Update docs for Windows workaround to solve databuilder extras_require error. #1861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following instructions are for setting up a version of Amundsen using Docker
4. Ingest provided sample data into Neo4j by doing the following: _(Please skip if you are using Atlas backend)_

* In a separate terminal window, change directory to [databuilder](https://github.com/amundsen-io/amundsen/tree/main/databuilder).
* `sample_data_loader` python script included in `examples/` directory uses _elasticsearch client_, _pyhocon_ and other libraries. Install the dependencies in a virtual env and run the script by following the commands below:
* `sample_data_loader` python script included in `examples/` directory uses _elasticsearch client_, _pyhocon_ and other libraries. Install the dependencies in a virtual env and run the script by following the commands below. See [Windows Troubleshooting](windows_troubleshooting.md) if you encounter an error on `python3 setup.py install` regarding `extas_require` on windows.
```bash
$ python3 -m venv venv
$ source venv/bin/activate
Expand Down
55 changes: 34 additions & 21 deletions docs/windows_troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,39 @@

1. Neo4j UI doesn't start

If Neo4j UI doesn't come up, check `neo4j` container logs. If you see output like below, then change the `End of Line Sequence` setting for `.\example\docker\neo4j\conf\neo4j.conf` file, using `VS Code`.
If Neo4j UI doesn't come up, check `neo4j` container logs. If you see output like below, then change the `End of Line Sequence` setting for `.\example\docker\neo4j\conf\neo4j.conf` file, using `VS Code`.

```
neo4j_amundsen | Changed password for user 'neo4j'.
neo4j_amundsen | Active database: amundsen.db
neo4j_amundsen | Directories in use:
neo4j_amundsen | home: /var/lib/neo4j
neo4j_amundsen | config: /var/lib/neo4j/conf
neo4j_amundsen | logs: /var/log/neo4j
neo4j_amundsen | plugins: /plugins
neo4j_amundsen | import: /var/lib/neo4j/import
neo4j_amundsen | data: /neo4j/data
neo4j_amundsen | certificates: /var/lib/neo4j/certificates
neo4j_amundsen | run: /var/lib/neo4j/run
neo4j_amundsen | Starting Neo4j.
'eo4j_amundsen | Unrecognized VM option 'UseG1GC
neo4j_amundsen | Did you mean '(+/-)UseG1GC'?
neo4j_amundsen | Error: Could not create the Java Virtual Machine.
neo4j_amundsen | Error: A fatal exception has occurred. Program will exit.
```
**VS Code Note:** Use <kbd>ctrl</kbd><kbd>shift</kbd><kbd>p</kbd> to open `Command Palette`. Choose `LF`. Press `Enter`.
```
neo4j_amundsen | Changed password for user 'neo4j'.
neo4j_amundsen | Active database: amundsen.db
neo4j_amundsen | Directories in use:
neo4j_amundsen | home: /var/lib/neo4j
neo4j_amundsen | config: /var/lib/neo4j/conf
neo4j_amundsen | logs: /var/log/neo4j
neo4j_amundsen | plugins: /plugins
neo4j_amundsen | import: /var/lib/neo4j/import
neo4j_amundsen | data: /neo4j/data
neo4j_amundsen | certificates: /var/lib/neo4j/certificates
neo4j_amundsen | run: /var/lib/neo4j/run
neo4j_amundsen | Starting Neo4j.
'eo4j_amundsen | Unrecognized VM option 'UseG1GC
neo4j_amundsen | Did you mean '(+/-)UseG1GC'?
neo4j_amundsen | Error: Could not create the Java Virtual Machine.
neo4j_amundsen | Error: A fatal exception has occurred. Program will exit.
```
**VS Code Note:** Use <kbd>ctrl</kbd><kbd>shift</kbd><kbd>p</kbd> to open `Command Palette`. Choose `LF`. Press `Enter`.

![](img/vscode-end-of-line-setting.png)
2. Installing [databuilder](https://github.com/amundsen-io/amundsen/tree/main/databuilder) fails due to `extras_require` error:

```
error in amundsen-databuilder setup command: 'extras_require' must be a dictionary whose values are
strings or lists of strings containing valid project/version requirement specifiers.
```

This error results from `databuilder/requirements_dev.txt` containing a symlink to `requirements_dev.txt` which is not properly
interpreted by Windows, resulting in the path being included as a requirement (which fails to parse as a requirement causing
the error). To work around this issue on windows, copy the root `requirements_dev.txt` over the file in `databuilder/`. This breaks
the link between the two files, meaning more work for windows developers to keep them in sync, but the `setup.py` script
will now function properly.

![](img/vscode-end-of-line-setting.png)