Skip to content

Commit

Permalink
Merge pull request #1688 from 18F/remove-requirements-again
Browse files Browse the repository at this point in the history
remove requirements.txt
  • Loading branch information
cantsin authored Oct 18, 2023
2 parents f3faf3f + ca6b01a commit f3d559c
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 61 deletions.
1 change: 0 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
package-lock.json binary
requirements.txt binary
Pipfile.lock binary
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We use Tock to track our time. You can read more about Tock in this [blog post](
| ------ | ------------ |
[![CircleCI](https://circleci.com/gh/18F/tock.svg?style=svg)](https://circleci.com/gh/18F/tock) | Continuous integration status provided by CirclCI.
[![Known Vulnerabilities Node](https://snyk.io/test/github/18f/tock/badge.svg?targetFile=package.json)](https://snyk.io/test/github/18f/tock?targetFile=package.json) | Known `node.js` Vulnerabilities status provided by Snyk.
[![Known Vulnerabilities Python](https://snyk.io/test/github/18f/tock?targetFile=requirements.txt)](https://snyk.io/test/github/18f/tock?targetFile=requirements.txt) | Known `python` Vulnerabilities status provided by Snyk.
[![Known Vulnerabilities Python](https://snyk.io/test/github/18f/tock/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/18f/tock?targetFile=requirements.txt) | Known `python` Vulnerabilities status provided by Snyk.

![Screenshot of Tock](/docs/screenshots/tock-homepage-screenshot-2021-3-15.png)

Expand Down
10 changes: 1 addition & 9 deletions docs/dependency-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,10 @@ Tock uses [Pipenv] to manage development and production dependencies.
In both development and continuous integration, the Python environment is
established with `pipenv install --dev`.

To accommodate third-party tools that do not yet support [Pipenv], [Pipenv] generates a `requirements.txt` file (containing
only production dependencies) and includes it in the repository.

With pipenv installed locally, you can update development and production dependencies with the following:

```sh
pipenv update --dev
pipenv requirements | sort > requirements.txt
```

Within the `app` docker container, the approach is slightly different due to the volumes and working_dir set in `docker-compose.yml`.
Expand All @@ -24,15 +20,12 @@ Within the `app` docker container, the approach is slightly different due to the
docker-compose run app bash
$ pipenv update --dev
$ cp ../Pipfile.lock ./Pipfile.lock
$ pipenv lock --requirements > requirements.txt
# Exit docker container
cp ./tock/Pipfile.lock ./Pipfile.lock
rm ./tock/Pipfile.lock
cp ./tock/requirements.txt ./requirements.txt
rm ./tock/requirements.txt
```

Either approach will result in updated `Pipfile.lock` and `requirements.txt` files located in your local copy of the codebase, ready for commit and submission of a pull request.
Either approach will result in an updated `Pipfile.lock` file located in your local copy of the codebase, ready for commit and submission of a pull request.

### Updating Python

Expand Down Expand Up @@ -72,7 +65,6 @@ description to the `.gitattributes` file at the root of the repository with the
`binary` flag.

- `package-lock.json`
- `requirements.txt`
- `Pipfile.lock`

[Pipenv]: https://docs.pipenv.org/
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ in the root directory of this project, prefixed with `manifest-` and ending in a

During local development and continuous integration testing,
`pipenv install --dev` is used. This installs both development
and production dependencies. During deployments, the `requirements.txt` file is used to install dependencies.
and production dependencies.

### Cloud Foundry structure

Expand Down
49 changes: 0 additions & 49 deletions requirements.txt

This file was deleted.

0 comments on commit f3d559c

Please sign in to comment.