Skip to content

Commit eddf612

Browse files
authored
docs: patch urls in README.md (#9)
* chore: patch urls in README.md * ci: relaxing rules around paths-ignore * docs: patching old namespace name in readme
1 parent 01e0adb commit eddf612

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

.github/workflows/cd.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ on:
55
branches:
66
- main
77
paths-ignore:
8-
- "**.md"
98
- "docs/**"
109
- "scripts/**"
1110
- "examples/**"

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
Algorand Python Testing is a companion package to [Algorand Python](https://github.com/algorandfoundation/puya) that enables efficient unit testing of Algorand Python smart contracts in an offline environment. It emulates key AVM behaviors without requiring a network connection, offering fast and reliable testing capabilities with a familiar Pythonic interface.
1515

16-
[Documentation](https://algorandfoundation.github.io/algopy_testing/index.html) | [Algorand Python Documentation](https://algorandfoundation.github.io/puya/)
16+
[Documentation](https://algorandfoundation.github.io/algorand-python-testing/) | [Algorand Python Documentation](https://algorandfoundation.github.io/puya/)
1717

1818
## Quick start
1919

@@ -25,7 +25,7 @@ Alternatively, if you want to start from scratch:
2525
2. Install [AlgoKit CLI](https://github.com/algorandfoundation/algokit-cli?tab=readme-ov-file#install)
2626
3. Install Algorand Python Testing into your project:
2727
```bash
28-
pip install algopy-testing-python
28+
pip install algorand-testing-python
2929
```
3030
4. Create a test file (e.g., `test_contract.py`):
3131

@@ -40,7 +40,7 @@ Alternatively, if you want to start from scratch:
4040

4141
5. Run your tests using your preferred Python testing framework (e.g., pytest, unittest)
4242

43-
For more detailed information, check out the [full documentation](https://algorandfoundation.github.io/algopy_testing).
43+
For more detailed information, check out the [full documentation](https://algorandfoundation.github.io/algorand-python-testing/).
4444

4545
## Features
4646

@@ -51,7 +51,7 @@ For more detailed information, check out the [full documentation](https://algora
5151

5252
## Examples
5353

54-
For detailed examples showcasing various testing scenarios, refer to the [examples section](https://algorandfoundation.github.io/algopy_testing/examples.html) in the documentation.
54+
For detailed examples showcasing various testing scenarios, refer to the [examples section](https://algorandfoundation.github.io/algorand-python-testing/examples.html) in the documentation.
5555

5656
## Contributing
5757

0 commit comments

Comments
 (0)