Skip to content

Commit

Permalink
Merge pull request #35 from Ostorlab/fix/update_references_to_docs
Browse files Browse the repository at this point in the history
Update references to docs
  • Loading branch information
3asm authored Mar 18, 2024
2 parents a45ea82 + c9e36d6 commit c14fdd1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ostorlab Template Agent
# OXO Template Agent

This repo is a template for building an [Ostorlab](https://github.com/ostorlab/ostorlab) agent in Python. It ships with good best practices like:

Expand All @@ -11,10 +11,10 @@ This repo is a template for building an [Ostorlab](https://github.com/ostorlab/o

Here are links to good resources to get started:

* [Write your first Agent](https://docs.ostorlab.co/tutorials/write-an-ostorlab-agent.html)
* [Use Ostorlab to run scans](https://docs.ostorlab.co/tutorials/run-your-first-scan.html)
* [Debugging and Testing Agents](https://docs.ostorlab.co/tutorials/debugging-agents.html)
* [Understand Ostorlab Internals](https://docs.ostorlab.co/tutorials/life-of-a-scan.html)
* [Write your first Agent](https://oxo.ostorlab.co/tutorials/write_an_agent)
* [Use OXO to run scans](https://oxo.ostorlab.co/tutorials)
* [Debugging and Testing Agents](https://oxo.ostorlab.co/tutorials/debugging_agents)
* [Understand OXO Internals](https://oxo.ostorlab.co/tutorials/life_of_a_scan)

## Ideas for Agents to build

Expand Down
1 change: 1 addition & 0 deletions agent/template_agent.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Sample agent implementation"""

import logging
from rich import logging as rich_logging

Expand Down
10 changes: 5 additions & 5 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""
Dummy conftest.py for template_agent.
Dummy conftest.py for template_agent.
If you don't know what this is for, just leave it empty.
Read more about conftest.py under:
- https://docs.pytest.org/en/stable/fixture.html
- https://docs.pytest.org/en/stable/writing_plugins.html
If you don't know what this is for, just leave it empty.
Read more about conftest.py under:
- https://docs.pytest.org/en/stable/fixture.html
- https://docs.pytest.org/en/stable/writing_plugins.html
"""

# import pytest

0 comments on commit c14fdd1

Please sign in to comment.