Skip to content

Commit

Permalink
1.0.3 (#126)
Browse files Browse the repository at this point in the history
* Bump urllib3 from 2.0.4 to 2.0.5 (#123)

Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.0.4 to 2.0.5.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](urllib3/urllib3@2.0.4...v2.0.5)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump charset-normalizer from 3.2.0 to 3.3.0 (#124)

Bumps [charset-normalizer](https://github.com/Ousret/charset_normalizer) from 3.2.0 to 3.3.0.
- [Release notes](https://github.com/Ousret/charset_normalizer/releases)
- [Changelog](https://github.com/Ousret/charset_normalizer/blob/master/CHANGELOG.md)
- [Commits](jawah/charset_normalizer@3.2.0...3.3.0)

---
updated-dependencies:
- dependency-name: charset-normalizer
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update documentation (#125)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
jvrck and dependabot[bot] authored Oct 7, 2023
1 parent 7693953 commit 430917b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This application works with [Bitbucket App Passwords](https://support.atlassian.

## Environment Settings

The ripper requires the following environment variables to run.
The application requires the following environment variables to run.

`BB_USER` The username component of the Bitbucket App Password.

Expand All @@ -18,31 +18,31 @@ The ripper requires the following environment variables to run.

`BB_RIPPER_EXPORT_DIRECTORY` The path of the output.

You can use the optional environment variable `BB_TEST_COUNTER` to only pull down a specified number of repositories. This is useful for testing purposes. All values that are non integer and lower that 1 will be ignored.
With the optional environment variable `BB_TEST_COUNTER` you can pull down only a specified number of repositories. This is useful for testing purposes. All values that are non integer and lower that 1 will be ignored.

## Running the ripper

### Local Environment

This has been developed and tested on `Python 3.11.2` and MacOS
The application was developed and tested on MacOS with the [Python 3.11 package](https://formulae.brew.sh/formula/python@3.11) managed with [Homebrew](https://brew.sh/).

To install python dependencies
To install Python dependencies

```bash
pip install -r requirements.txt
```

### Set the environment variables

Open `env_setup.sh.example` and add the values for your environment. Rename the file to `env_setup.sh` Source the environment variables to add the to you session.
To set the environment variables: Rename `env_setup.sh.example` to `env_setup.sh` after adding values for your environment, then source the environment variables to add them to your session.

```bash
source env_setup.sh
```

### Run

To run the ripper
To run the application

```bash
cd bb-ripper
Expand All @@ -51,7 +51,7 @@ python3 .

### Running the docker image

To run the image, create a docker environment file with the variables required named `docenv`. Create a directory named `data` to store the repositories. This directory will be mounted to the `/data` volume in the container.
To run the docker image: Create a Docker environment file with the variables required, named `docenv`. Create a directory named `data` to store the repositories. This directory will be mounted to the `/data` volume in the container.

The repository contains a file named `docenv.example` that is a template for the `docenv` file.

Expand All @@ -76,7 +76,7 @@ To run the image, create a docker environment file with the variables required n

## Docker image with AWS CLI

There is a variant of the image that has the AWS CLI preinstalled. This is done during the build by passing a build argument to the Docker `build` command.
A variant of the image that has the AWS CLI preinstalled. This can be done during the build by passing a build argument to the Docker `build` command.

```bash
docker build --no-cache -t bbripper-aws --build-arg AWSCLI=TRUE .
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
certifi==2023.7.22
charset-normalizer==3.2.0
charset-normalizer==3.3.0
idna==3.4
requests==2.31.0
urllib3==2.0.4
urllib3==2.0.5

0 comments on commit 430917b

Please sign in to comment.