| Name | bddcmd JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | A CLI tool for completing boot.dev lessons |
| upload_time | 2024-08-21 02:21:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bdd
`bdd` is a command line tool for completing [Boot.dev](https://boot.dev) lessons in the terminal.
**Why?** The Boot.dev web interface is great. If you find the videos helpful or enjoy the gamification elements, stick to the web interface. But if you want to hone your skills in the command line and gain familiarity with your editor, give `bdd` a try.
Interested in contributing? Check out the [contribution guidelines](docs/CONTRIBUTING.md).
## Prereqs
This tool relies on the [Boot.dev CLI](https://github.com/bootdotdev/bootdev/tree/main) to simplify initial authentication. Install the tool and run `bootdev login` before attempting to use `bdd`.
Python `3.10` or greater is recommended.
Windows file paths are not supported at this time but [could be](docs/CONTRIBUTING.md).
## Installation
Note the pypi package name is `bddcmd`, but the command is `bdd`. It's 2024, and short names are scarce.
```bash
python3 -m pip install bddcmd
bdd --help
```
## Usage
Run `bdd init` to set up your configuration. You will specify how to run go python (ex: `python` vs `python3`), go (ex: `go` vs `go[version]`), etc. Note that the editor command should accept a list of files to open. For example, `nvim -p` (default) for Neovim, `code` for VS Code, or a `/mnt/c/Program Files/` path if you code in the [best IDE for programming](https://youtu.be/X34ZmkeZDos).
`bdd connect` will open a websocket connection to receive success/failure messages when submitting lessons. You will likely want this in a visible terminal while working.
`bdd get [Boot.dev lesson URL]` will retrieve the lesson files and open them with the editor stored in your configuration.
`bdd next` and `bdd prev` will move between lessons. `bdd get` without a URL will get the lesson contents based on your current position. This is useful after changing position and also for resuming work after exiting your editor.
`bdd run` and `bdd submit` function similarly to the respective Boot.dev commands.
`bdd progress` will show your progress in the current course, including lesson completion status.
## Development
### Virtual environment
Create your virtual environment. I recommend `venv` which is part of the standard library as of `3.3`.
```bash
python3 -m venv .venv
```
and activate it with `source .venv/bin/activate`.
### Install for development with dependencies
`python3 -m pip install -e .[dev]`
### Add a dependency
Add to `pyproject.yaml` then repeat the `pip install` command above.
### Manual testing
```bash
bdd --help
```
### Automated testing
After following the dev installation steps:
```bash
pytest
```
### Testing a build
```bash
# (in a venv, most likely)
python3 -m build
python3 -m pip install dist/bddcmd-[version].tar.gz
```
### Release
```
python3 -m pip install --upgrade build
python3 -m build
```
Add credentials to `.pypirc` and run:
```bash
python3 -m pip install --upgrade twine
python3 -m twine upload --repository testpypi dist/* # testpypi
# python3 -m twine upload dist/* # pypi
```
Activate a venv and install the package from testpypi to test.
```bash
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps bdd
```
## How boot.dev lessons work
`bdd` essentially relies on an undocumented, internal set of boot.dev APIs and conventions. Yes, this is gross, and it will definitely break as changes are made to the platform. The "bet" is that the functionality will be worth this inconvenience.
See [bdd.md](docs/bdd.md) for more information on how boot.dev lessons work and some examples.
Raw data
{
"_id": null,
"home_page": null,
"name": "bddcmd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Casey Woolfolk <ccwoolfolk@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/91/51/fdb7cd44483a858cc650faa92b314c647f8d73c081c7c16345743fe501ce/bddcmd-1.0.1.tar.gz",
"platform": null,
"description": "# bdd\n\n`bdd` is a command line tool for completing [Boot.dev](https://boot.dev) lessons in the terminal.\n\n**Why?** The Boot.dev web interface is great. If you find the videos helpful or enjoy the gamification elements, stick to the web interface. But if you want to hone your skills in the command line and gain familiarity with your editor, give `bdd` a try.\n\n\n\nInterested in contributing? Check out the [contribution guidelines](docs/CONTRIBUTING.md).\n\n## Prereqs\n\nThis tool relies on the [Boot.dev CLI](https://github.com/bootdotdev/bootdev/tree/main) to simplify initial authentication. Install the tool and run `bootdev login` before attempting to use `bdd`.\n\nPython `3.10` or greater is recommended.\n\nWindows file paths are not supported at this time but [could be](docs/CONTRIBUTING.md).\n\n## Installation\n\nNote the pypi package name is `bddcmd`, but the command is `bdd`. It's 2024, and short names are scarce.\n\n```bash\npython3 -m pip install bddcmd\nbdd --help\n```\n## Usage\n\nRun `bdd init` to set up your configuration. You will specify how to run go python (ex: `python` vs `python3`), go (ex: `go` vs `go[version]`), etc. Note that the editor command should accept a list of files to open. For example, `nvim -p` (default) for Neovim, `code` for VS Code, or a `/mnt/c/Program Files/` path if you code in the [best IDE for programming](https://youtu.be/X34ZmkeZDos).\n\n`bdd connect` will open a websocket connection to receive success/failure messages when submitting lessons. You will likely want this in a visible terminal while working.\n\n`bdd get [Boot.dev lesson URL]` will retrieve the lesson files and open them with the editor stored in your configuration.\n\n`bdd next` and `bdd prev` will move between lessons. `bdd get` without a URL will get the lesson contents based on your current position. This is useful after changing position and also for resuming work after exiting your editor.\n\n`bdd run` and `bdd submit` function similarly to the respective Boot.dev commands.\n\n`bdd progress` will show your progress in the current course, including lesson completion status.\n\n## Development\n\n### Virtual environment\n\nCreate your virtual environment. I recommend `venv` which is part of the standard library as of `3.3`.\n\n```bash\npython3 -m venv .venv\n```\n\nand activate it with `source .venv/bin/activate`.\n\n### Install for development with dependencies\n\n`python3 -m pip install -e .[dev]`\n\n### Add a dependency\n\nAdd to `pyproject.yaml` then repeat the `pip install` command above.\n\n### Manual testing\n\n```bash\nbdd --help\n```\n\n### Automated testing\n\nAfter following the dev installation steps:\n\n```bash\npytest\n```\n\n### Testing a build\n\n```bash\n# (in a venv, most likely)\npython3 -m build\npython3 -m pip install dist/bddcmd-[version].tar.gz\n```\n\n### Release\n\n```\npython3 -m pip install --upgrade build\npython3 -m build\n```\n\nAdd credentials to `.pypirc` and run:\n\n```bash\npython3 -m pip install --upgrade twine\npython3 -m twine upload --repository testpypi dist/* # testpypi\n# python3 -m twine upload dist/* # pypi\n```\nActivate a venv and install the package from testpypi to test.\n\n```bash\npython3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps bdd\n```\n\n## How boot.dev lessons work\n\n`bdd` essentially relies on an undocumented, internal set of boot.dev APIs and conventions. Yes, this is gross, and it will definitely break as changes are made to the platform. The \"bet\" is that the functionality will be worth this inconvenience.\n\nSee [bdd.md](docs/bdd.md) for more information on how boot.dev lessons work and some examples.\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool for completing boot.dev lessons",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/ccwoolfolk/bdd",
"Issues": "https://github.com/ccwoolfolk/bdd/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6241d690c6f5b7118eef5684beba7a591b2dcdc9ff68c693697db73b77ef1c74",
"md5": "b1835c68d7771435a6ba684d2c45a049",
"sha256": "871368d9aedcc92184ba13d00bc5d6257e322625271447e5c451ea91ac32952c"
},
"downloads": -1,
"filename": "bddcmd-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1835c68d7771435a6ba684d2c45a049",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17531,
"upload_time": "2024-08-21T02:21:41",
"upload_time_iso_8601": "2024-08-21T02:21:41.847193Z",
"url": "https://files.pythonhosted.org/packages/62/41/d690c6f5b7118eef5684beba7a591b2dcdc9ff68c693697db73b77ef1c74/bddcmd-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9151fdb7cd44483a858cc650faa92b314c647f8d73c081c7c16345743fe501ce",
"md5": "02b5754f0593b4c752f868cf06c67f10",
"sha256": "2e7b25c8a23b2816e2213e13dae98fa42d2f02ca608981c7237c4a2242b8bd1f"
},
"downloads": -1,
"filename": "bddcmd-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "02b5754f0593b4c752f868cf06c67f10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16420,
"upload_time": "2024-08-21T02:21:43",
"upload_time_iso_8601": "2024-08-21T02:21:43.246456Z",
"url": "https://files.pythonhosted.org/packages/91/51/fdb7cd44483a858cc650faa92b314c647f8d73c081c7c16345743fe501ce/bddcmd-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 02:21:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ccwoolfolk",
"github_project": "bdd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bddcmd"
}
