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.

Sign up for GitHub

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

Jump to bottom

Project setup for local development #4

Closed
4 tasks done
Tracked by #3
emilyashley opened this issue Dec 1, 2022 · 0 comments · Fixed by #8
Closed
4 tasks done
Tracked by #3

Project setup for local development #4

emilyashley opened this issue Dec 1, 2022 · 0 comments · Fixed by #8
Assignees
@emilyashley

Comments

@emilyashley
Copy link
Contributor

emilyashley commented Dec 1, 2022 •
edited

We'd like the project to be set up for local development, this includes:

  • pyproject setup and poetry
  • a system for linting. see: pylint, pycodestyle
  • a testing suite setup with a hello world example; code coverage
  • and a readme / dev instructions for each of these aspects!

See also #2 required for local setup for development and troubleshooting.
@emilyashley emilyashley self-assigned this Dec 1, 2022
This was referenced Dec 1, 2022
Closed
Merged
Closed
emilyashley added a commit that referenced this issue Dec 1, 2022
@emilyashley @MikeGoldsmith
maint: local project setup - hello world in package, testing, linting…
3a9fa11 
…, and example flask app (#8)

<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Which problem is this PR solving?

- Closes #4
- Starts #2 

## Short description of the changes
- Introduces 
   - linting via pylint
   - codestyle
   - testing hello world via poetry, pytest
   - code coverage
- example flask application using upstream distro and a local import of
hello world

## How to verify that this has the expected result
Try out the readmes. Does it work? What did you run into? 
Can you send data to console or honeycomb using the flask app setup with
the base OTel Distro?
Can you edit files and see the changes in tests?
Can you edit files and see the changes in the example flask app?

Note: the readme is focused on starting development internally right
now, #20 is for getting it shiny for public ✨

Co-authored-by: Mike Goldsmth <goldsmith.mike@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emilyashley emilyashley

Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@emilyashley