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.

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

Improve setup #37075

Merged
merged 3 commits into from
Jun 25, 2020
Merged

Improve setup #37075

merged 3 commits into from
Jun 25, 2020

Conversation

balloob
Copy link
Member

@balloob balloob commented Jun 24, 2020

Breaking change

Proposed change

Updates our setup script for latest changes (auto configures logger) and also makes sure a venv exists.

Dev docs PR: home-assistant/developers.home-assistant#588

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@balloob
Copy link
Member Author

balloob commented Jun 24, 2020

@frenck since we limit dev setup to Debian/Ubuntu, we could put the apt installation in script/bootstrap. What do you think ?

logger:
default: info
logs:
homeassistant.components.cloud: debug
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding debug logging for a single integration to show how it works.

@frenck
Copy link
Member

frenck commented Jun 25, 2020

@balloob I think using apt is really tricky. For example, pyenv? anaconda?

It is still a development environment where one would go apart from what is normal at this point in time.

@frenck
Copy link
Member

frenck commented Jun 25, 2020

How about dropping tox for just plain pytest?

mkdir -p config

python3 -m venv venv
source venv/bin/activate
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to document that if the developer wants to maintain another environment the developer can't use this script?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean with maintain another environment? Like have one virtual env that mixes both HA deps and deps of another project? That isn't supported. For installing external deps, people should do pip3 install -e /path/to/project

Copy link
Member

@MartinHjelmare MartinHjelmare Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No I mean use another venv tool and venv location. Eg I use virtualenv and virtualenvwrapper to manage my venvs. So this script won't be compatible with that setup.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that those users should look into the script and figure out it's just pip3 install -e .. venv is official part of Python and should be the preferred venv.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we can also add support for an ENV var to skip the virtual env.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we just check for $VIRTUAL_ENV being set, and abort if not. It should cover most bases.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that is a thing, yes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is set by activate script. May not be set if a binary is run directly in venv, but that should be case we need to care about.

@balloob
Copy link
Member Author

balloob commented Jun 25, 2020

So the reason tox is in there is because it means setting up a dev environment takes very little time because we defer installing test dependencies.

@balloob balloob merged commit 4aedafc into dev Jun 25, 2020
@balloob balloob deleted the improve-setup branch June 25, 2020 18:34
@balloob
Copy link
Member Author

balloob commented Jun 25, 2020

Leaving apt out because it would mess with Mac OS dev setups. I think that we could consider asking the user if they want to install those things, and then allow setting an ENV var to auto approve.

@balloob
Copy link
Member Author

balloob commented Jun 25, 2020

I think ideally we would have the dev container also use this script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix cla-signed small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants