Skip to content

pyds

Usage:

$ pyds [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • analysis
  • configure: Initial configuration for pyds.
  • env
  • pixi
  • project
  • system
  • talk
  • version: Print the current version of pyds.

pyds analysis

Usage:

$ pyds analysis [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Add dependencies to the analysis notebook.
  • create: Create a new notebook in the notebooks...
  • init: Initialize a new data analysis project...
  • run: Start working on the analysis in Jupyter.

pyds analysis add

Add dependencies to the analysis notebook.

Usage:

$ pyds analysis add [OPTIONS]

Options:

  • -p, --package TEXT: Packages to add to the notebook
  • --notebook PATH: Path to the notebook to modify [default: analysis.ipynb]
  • --requirements PATH: Requirements file to add dependencies from
  • --extra TEXT: Extra dependency group to add (e.g. 'dev')
  • --help: Show this message and exit.

pyds analysis create

Create a new notebook in the notebooks directory with default dependencies.

Usage:

$ pyds analysis create [OPTIONS] NAME

Arguments:

  • NAME: Name of the notebook to create. Will be created in the notebooks directory. [required]

Options:

  • -p, --package TEXT: Additional packages to include
  • --help: Show this message and exit.

pyds analysis init

Initialize a new data analysis project with a juv-managed notebook.

Usage:

$ pyds analysis init [OPTIONS]

Options:

  • --python TEXT: Minimum Python version for the analysis
  • --notebook PATH: Name of the notebook to create [default: analysis.ipynb]
  • --help: Show this message and exit.

pyds analysis run

Start working on the analysis in Jupyter.

Usage:

$ pyds analysis run [OPTIONS]

Options:

  • --notebook PATH: Path to the notebook to run [default: analysis.ipynb]
  • --jupyter TEXT: Specific Jupyter frontend to use (e.g. lab, notebook)
  • --with TEXT: Additional dependencies for this session
  • --help: Show this message and exit.

pyds configure

Initial configuration for pyds.

:param name: Your name. :param email: Your email address. :param github_username: Your GitHub username. :param twitter_username: Your Twitter username. :param linkedin_username: Your LinkedIn username.

Usage:

$ pyds configure [OPTIONS]

Options:

  • --name TEXT: Your name [required]
  • --email TEXT: Your email address [required]
  • --github-username TEXT: Your GitHub username
  • --twitter-username TEXT: Your Twitter username
  • --linkedin-username TEXT: Your LinkedIn username
  • --help: Show this message and exit.

pyds env

Usage:

$ pyds env [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • delete: Remove an environment variable from the...
  • set: Set a key-value pair in the .env file.
  • show: Show all environment variables.

pyds env delete

Remove an environment variable from the .env file.

:param key: The name of the environment variable.

Usage:

$ pyds env delete [OPTIONS] KEY

Arguments:

  • KEY: [required]

Options:

  • --help: Show this message and exit.

pyds env set

Set a key-value pair in the .env file.

:param key: The name of the environment variable. :param value: The value to set the environment variable to.

Usage:

$ pyds env set [OPTIONS] KEY VALUE

Arguments:

  • KEY: [required]
  • VALUE: [required]

Options:

  • --help: Show this message and exit.

pyds env show

Show all environment variables.

:param keys: Whether to show the keys or not. :param values: Whether to show the values or not.

Usage:

$ pyds env show [OPTIONS]

Options:

  • --keys / --no-keys: [default: keys]
  • --values / --no-values: [default: no-values]
  • --help: Show this message and exit.

pyds pixi

Usage:

$ pyds pixi [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • rebuild: Rebuild the pixi environment.

pyds pixi rebuild

Rebuild the pixi environment.

This command should be used whenever you suspect that your Pixi environment might be broken. This may show up in packages cryptically having files not being found.

Usage:

$ pyds pixi rebuild [OPTIONS]

Options:

  • --help: Show this message and exit.

pyds project

Usage:

$ pyds project [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • init: Initialize a new Python data science project.

pyds project init

Initialize a new Python data science project.

Usage:

$ pyds project init [OPTIONS]

Options:

  • --help: Show this message and exit.

pyds system

Usage:

$ pyds system [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • init: Bootstrap user's system with necessary...
  • status: Report status for tools that we expect to...

pyds system init

Bootstrap user's system with necessary programs.

Usage:

$ pyds system init [OPTIONS]

Options:

  • --help: Show this message and exit.

pyds system status

Report status for tools that we expect to have installed.

We check for the presence of:

  1. A pixi installation.
  2. A homebrew installation.
  3. The presence of a .pypirc file.

Usage:

$ pyds system status [OPTIONS]

Options:

  • --help: Show this message and exit.

pyds talk

Usage:

$ pyds talk [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • init: Initialize a new talk repository.

pyds talk init

Initialize a new talk repository.

Usage:

$ pyds talk init [OPTIONS]

Options:

  • --help: Show this message and exit.

pyds version

Print the current version of pyds.

Usage:

$ pyds version [OPTIONS]

Options:

  • --help: Show this message and exit.