Skip to content

Commit

Permalink
Update README for Go modules
Browse files Browse the repository at this point in the history
Simplifies a lot of the process needed to get things up and running.
  • Loading branch information
slai committed Jan 3, 2019
1 parent dd41d2d commit e8a7529
Showing 1 changed file with 9 additions and 29 deletions.
38 changes: 9 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,30 @@
go-minipypi
===========

Bare minimums implementation of a Pypi server that proxies all requests to an S3 bucket.
A bare minimum implementation of a PyPI server that proxies all requests to an S3 bucket.

This was implemented by looking what was required to get pip install commands such as this one working:
> pip install -v --no-index --find-links=http://localhost:8080/ -r requirements.txt
it does the job.
Installation
------------

1. Install [go 1.11](https://golang.org/dl/) or later.

Instalation
-----------
2. Clone this repository to somewhere outside of your GOPATH.

1. Install go:
3. Build the code:

```
brew install go
```

2. Setup your GOPATH env variable and pull the code:

```
go get github.com/citymapper/go-minipypi
```

3. Install the requirements (if you haven't done so already)

```
go get github.com/aws/aws-sdk-go/aws
go get gopkg.in/yaml.v2
```

4. Build the code:

```
cd $GOPATH/src/github.com/citymapper/go-minipypi
```sh
go build .
```

5. Run it:
4. Run it:

```
./go-minipypi
```

Notes:
------
Its requires a config file, see config.yml.
It requires a ini file that holds the AWS credentials. See aws_credentials.ini
It requires a config file, see `config.yml`. Drop the `credentialsfile` parameter to use the [default AWS credentials chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).

0 comments on commit e8a7529

Please sign in to comment.