Skip to content

Install llnl-scraper from PyPI #229

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Install llnl-scraper from PyPI #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f6e0ed
Install `llnl-scraper` from PyPI
mcdonnnj Jul 13, 2025
412ba76
Update Python virtual environment dependencies
mcdonnnj Jul 13, 2025
68fed8d
Bump version from 0.3.0-rc.6 to 0.3.0-rc.7
mcdonnnj Jul 13, 2025
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ hosted [here](https://www.dhs.gov/code.json).
To run the `cisagov/code-gov-update` image via Docker:

```console
docker run cisagov/code-gov-update:0.3.0-rc.6
docker run cisagov/code-gov-update:0.3.0-rc.7
```

### Running with Docker Compose ###
Expand All @@ -46,7 +46,7 @@ docker run cisagov/code-gov-update:0.3.0-rc.6
environment:
- AWS_CONFIG_FILE=path/to/aws_config
- AWS_PROFILE=default
image: cisagov/code-gov-update:0.3.0-rc.6
image: cisagov/code-gov-update:0.3.0-rc.7
init: true
```

Expand Down Expand Up @@ -94,7 +94,7 @@ environment variables. See the
environment:
- AWS_CONFIG_FILE=/run/secrets/aws_config
- AWS_PROFILE=default
image: cisagov/code-gov-update:0.3.0-rc.6
image: cisagov/code-gov-update:0.3.0-rc.7
init: true
secrets:
- source: aws_config
Expand Down Expand Up @@ -130,7 +130,7 @@ environment variables. See the
1. Pull the new image:

```console
docker pull cisagov/code-gov-update:0.3.0-rc.6
docker pull cisagov/code-gov-update:0.3.0-rc.7
```

1. Recreate and run the container by following the [previous instructions](#running-with-docker).
Expand Down Expand Up @@ -169,11 +169,11 @@ and then update dependencies as you would above.
The images of this container are tagged with [semantic
versions](https://semver.org) of the underlying example project that they
containerize. It is recommended that most users use a version tag (e.g.
`:0.3.0-rc.6`).
`:0.3.0-rc.7`).

| Image:tag | Description |
|-----------|-------------|
|`cisagov/code-gov-update:0.3.0-rc.6`| An exact release version. |
|`cisagov/code-gov-update:0.3.0-rc.7`| An exact release version. |
|`cisagov/code-gov-update:0.3`| The most recent release matching the major and minor version numbers. |
|`cisagov/code-gov-update:0`| The most recent release matching the major version number. |
|`cisagov/code-gov-update:edge` | The most recent image built from a merge into the `develop` branch of this repository. |
Expand Down Expand Up @@ -238,7 +238,7 @@ Build the image locally using this git repository as the [build context](https:/

```console
docker build \
--tag cisagov/code-gov-update:0.3.0-rc.6 \
--tag cisagov/code-gov-update:0.3.0-rc.7 \
https://github.com/cisagov/code-gov-update.git#develop
```

Expand Down Expand Up @@ -269,7 +269,7 @@ Docker:
--file Dockerfile-x \
--platform linux/amd64 \
--output type=docker \
--tag cisagov/code-gov-update:0.3.0-rc.6 .
--tag cisagov/code-gov-update:0.3.0-rc.7 .
```

## Contributing ##
Expand Down
8 changes: 2 additions & 6 deletions src/Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,8 @@ boto3 = ">=1.13.23"
# available for Alpine Linux 3.22.
cryptography = "44.0.3"
docopt = ">=0.6.2"
# We need a bugfix for behavior in newer versions of cloc. Since there is not a
# release on PyPI with the code in https://github.com/LLNL/scraper/pull/79, we
# must instead pull directly from the GitHub repository. We use the latest (as
# of this comment) commit on the default branch to serve as our version pin
# equivalent.
llnl-scraper = {file = "https://api.github.com/repos/LLNL/scraper/tarball/536a72ce1ceb2e209281ff72a2ed59e735d45c33"}
# Minimum version with newer versions of cloc compatibility
llnl-scraper = ">=0.15.0"
Copy link

Copilot AI Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding an upper bound to this dependency (e.g., ">=0.15.0,<0.16.0") to follow semver and prevent unintended breaking changes, and regenerate the Pipfile.lock to lock down the updated version.

Suggested change
llnl-scraper = ">=0.15.0"
llnl-scraper = ">=0.15.0,<0.16.0"

Copilot uses AI. Check for mistakes.
Copy link
Member Author

@mcdonnnj mcdonnnj Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Due to the slow developmental cycle of the llnl-scraper project I am not particularly worried about an upper bound. @cisagov/vm-dev any preference?

Copy link
Member

@dav3r dav3r Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have strong feelings either way here, though it probably doesn't hurt to have an upper bound.

Copy link
Member Author

@mcdonnnj mcdonnnj Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we can either do a <1 or just pin to a hard minor version because the history of releases for this project has been 0.x.0 versions.

Copy link
Member

@dav3r dav3r Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My vote is to pin to a specific minor version.

Copy link
Member

@jsf9k jsf9k Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't care less. Do what thou wilt.

Copy link
Member Author

@mcdonnnj mcdonnnj Jul 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A key reminder here is that this is just a general requirements specification. It is only used when locking the lockfile. The lockfile specifies what specific version of a package is to be installed.


[requires]
python_full_version = "3.12.11"
29 changes: 17 additions & 12 deletions src/Pipfile.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/version.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.3.0-rc.6
0.3.0-rc.7