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

Create directories and pyproject.toml #1

Closed
lisphilar opened this issue Oct 4, 2022 · 3 comments · Fixed by #2 or #3
Closed

Create directories and pyproject.toml #1

lisphilar opened this issue Oct 4, 2022 · 3 comments · Fixed by #2 or #3
Assignees

Comments

@lisphilar
Copy link
Contributor

This is the initial issue and to set-up development environment.

  1. Create the following directories and pyproject.toml with poetry.
$ tree
.
├── LICENSE
├── README.md
├── dim
│   ├── __init__.py
│   └── __version__.py
├── poetry.lock
├── pyproject.toml
└── tests
    ├── __init__.py
    └── test_metadata.py
  1. As discussed in Slack, users will install this library with poetry add dim-python or pip install dim-python after release.

  2. Users will use the library with import dim; dim.__version__.

  3. Documentation will be on README.md at this time. We may use Sphinx later.

  4. The following dependencies will be used for tests, if acceptable.

  • pytest = "^7.1.3"
  • pytest-cov = "^4.0.0"
  • flake8 = "^5.0.4"
  • autopep8 = "^1.7.0"
  • pyproject-flake8 = "^5.0.4.post1"
@lisphilar
Copy link
Contributor Author

.gitignore for Python will be also created.
Template: https://github.com/github/gitignore/blob/main/Python.gitignore

@lisphilar
Copy link
Contributor Author

Additionally, I added GitHub Actions workflow (.github/workflow/test.yml) to run tests for each push on main and pull requests.

@ryo-ma
Please review my initial pull request for this issue.

@ryo-ma ryo-ma linked a pull request Oct 4, 2022 that will close this issue
@ryo-ma ryo-ma closed this as completed in #2 Oct 4, 2022
ryo-ma added a commit that referenced this issue Oct 4, 2022
Issue #1: Create directories and pyproject.toml
@lisphilar
Copy link
Contributor Author

lisphilar commented Oct 5, 2022

Reopened to updates:

  • Rename ".github/workflow/" to ".github/workflows" (fix naming error to activate GitHub workflows)
  • Include Lint workflow with flake8 /autopep8, which were added as dev dev dependencies but not used test.yml
  • Add ".vscode/" (files for editors) to .gitignore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants