Skip to content

Commit

Permalink
#165: Remove details regarding tmpdir cmd option
Browse files Browse the repository at this point in the history
- This has been removed in a different branch so I've removed the documented details about it in this branch and adjusted it according to the new solution found
  • Loading branch information
MRichards99 committed Jan 4, 2021
1 parent 93d0980 commit 135965c
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,16 +189,10 @@ Currently, the following Nox sessions have been created:
Each Nox session builds an environment using the repo's dependencies (defined using
Poetry) using `install_with_constraints()`. This stores the dependencies in a
`requirements.txt`-like format temporarily during this process, using the OS' default
temporary location. This could result in permissions issues (this has been seen by a
colleague on Windows), so adding the `--tmpdir [DIRECTORY PATH]` allows the user to
define where this file should be stored. Due to Nox session being initiated in the
command line, this argument needs to be a positional argument (denoted by the `--` in
the Nox command). This argument is optional, but **must** be the final argument avoid
interference with Nox's argument parsing. An example:

```bash
nox -s lint -- util datagateway_api --tmpdir /root
```
temporary location. These files are manually deleted in `noxfile.py` (as opposed to
being automatically removed by Python) to minimise any potential permission-related
issues as documented
[here](https://github.com/bravoserver/bravo/issues/111#issuecomment-826990).


## Automated Checks during Git Commit (Pre Commit)
Expand Down

0 comments on commit 135965c

Please sign in to comment.