Skip to content

Commit

Permalink
pipeline update + readme for roadtx
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkjanm committed Nov 8, 2022
1 parent 99dbcc3 commit 260318f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 3 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ROADtools
*(**R**ogue **O**ffice 365 and **A**zure (active) **D**irectory tools)*

![Python 3 only](https://img.shields.io/badge/python-3.6+-blue.svg)
![Python 3 only](https://img.shields.io/badge/python-3.7+-blue.svg)
![License: MIT](https://img.shields.io/pypi/l/roadlib.svg)

<img src="roadrecon/frontend/src/assets/rt_transparent.svg" width="300px" alt="ROADtools logo" />

ROADtools is a framework to interact with Azure AD. It currently consists of a library (roadlib) and the ROADrecon Azure AD exploration tool.
ROADtools is a framework to interact with Azure AD. It consists of a library (roadlib) with common components, the ROADrecon Azure AD exploration tool and the ROADtools Token eXchange (roadtx) tool.

## ROADlib
![PyPI version](https://img.shields.io/pypi/v/roadlib.svg)
Expand Down Expand Up @@ -55,3 +55,26 @@ You can run the Angular frontend with `npm start` or `ng serve` using the Angula

### Using ROADrecon
See [this Wiki page](https://github.com/dirkjanm/ROADtools/wiki/Getting-started-with-ROADrecon) on how to get started.

## ROADtools Token eXchange (roadtx)
![PyPI version](https://img.shields.io/pypi/v/roadtx.svg)
[![Build Status](https://dev.azure.com/dirkjanm/ROADtools/_apis/build/status/dirkjanm.ROADtools?branchName=master)](https://dev.azure.com/dirkjanm/ROADtools/_build/latest?definitionId=19&branchName=master)

### Installation
There are multiple ways to install roadtx. Note that roadtx requires Python 3.7 or newer.

**Using a published version on PyPi**
Stable versions can be installed with `pip install roadtx`. This will automatically add the `roadtx` command to your PATH.

**Using a version from GitHub**
You can clone this repository and install `roadlib` and then `roadtx` to make sure you have the latest versions of both the tool and the library:

```
pip install roadlib/
pip install roadtx/
```

You can also install them in development mode with `pip install -e roadtx/`.

### Using roadtx
See [the Wiki](https://github.com/dirkjanm/ROADtools/wiki/ROADtools-Token-eXchange-(roadtx)) on how to use roadtx.
17 changes: 16 additions & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ jobs:
pip install .
python setup.py sdist
python setup.py bdist_wheel
displayName: 'Create ROADlib package'
displayName: 'Create roadlib package'
workingDirectory: roadlib
- script: |
Expand All @@ -119,6 +119,13 @@ jobs:
displayName: 'Create ROADrecon package'
workingDirectory: roadrecon
- script: |
pip install .
python setup.py sdist
python setup.py bdist_wheel
displayName: 'Create roadtx package'
workingDirectory: roadtx
- task: CopyFiles@2
displayName: 'Copy ROADrecon Files to: $(build.artifactstagingdirectory)'
inputs:
Expand All @@ -135,6 +142,14 @@ jobs:
TargetFolder: '$(build.artifactstagingdirectory)'
condition: succeededOrFailed()

- task: CopyFiles@2
displayName: 'Copy roadtx Files to: $(build.artifactstagingdirectory)'
inputs:
SourceFolder: 'roadtx/dist/'
Contents: '*'
TargetFolder: '$(build.artifactstagingdirectory)'
condition: succeededOrFailed()

- task: PublishBuildArtifacts@1
inputs:
pathtoPublish: '$(Build.ArtifactStagingDirectory)'
Expand Down

0 comments on commit 260318f

Please sign in to comment.