Update documentation (README and examples) #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brettimus
commented
Apr 5, 2023
|
|
||
| [See Why Autometrics?](https://github.com/autometrics-dev#why-autometrics) for more details on the ideas behind autometrics | ||
| 1. A decorator that can create [Prometheus](https://prometheus.io/) metrics for your functions and class methods throughout your code base. | ||
| 2. A helper function that will write corresponding Prometheus queries for you in a Markdown file. |
There was a problem hiding this comment.
i'm actually not sure if the "Markdown file" bit is accurate? if so, i should add an example
brettimus
commented
Apr 5, 2023
| from autometrics import autometrics | ||
|
|
||
| ```py | ||
| from autometrics.autometrics import autometrics |
There was a problem hiding this comment.
seems like we need to use from autometrics.autometrics - wondering if there's a way to make the import cleaner
There was a problem hiding this comment.
i'm thinking we might actually do something like:
import autometrics
@autometrics
...
couldn't we? half as joke but i think it's doable
There was a problem hiding this comment.
never mind, i forgor how python package resolution works. here's a pr that enables usage like from autometrics import autometrics
added 6 commits
April 5, 2023 18:46
brettimus
force-pushed
the
update-docs-20230405
branch
from
f989ec6 to
ff0b691
Compare
flenter
approved these changes
Apr 6, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the following:
examplesfoldercallerdata