Skip to content
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.

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

Add installation instructions for pom-* #41

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 43 additions & 0 deletions src/python/fsqio/pants/pom/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Installation

Copy these files from the fsqio repo:
```
src/python/fsqio/__init__.py
src/python/fsqio/pants/__init__.py
src/python/fsqio/pants/pom/*
```

You can delete `src/python/fsqio/pants/pom/BUILD` unless you're planning on writing tests for or publishing the pom-resolve; this means you don't need to put the deps in your 3rdparty file.

Add this to your pants.ini:

```
# Note this is effectively requirements.txt for the pants environment, so we need the deps of
# our build dependancies, see: https://github.com/pantsbuild/pants/issues/4001
[GLOBAL]
plugins: +[
"requests==2.5.3",
"requests-futures==0.9.4",
]
backend_packages: +[
"fsqio.pants.pom",
]
[pom-resolve]
# Fill in these values as appropriate; there's good defaults in fsqio's pants.ini
maven_repos: [
...
]
global_exclusions = [
...
]
global_pinned_versions = [
...
]
local_override_versions = [
...
]

[cache.pom-resolve]
write_to: ...
read_from: ...
```