It is used to install packages from Python Package Index (PyPI) and other indexes. Sphinx build command given in step 3 of Generating the documentation.PIP is the Package Installer for Python.
#Pip install mongodb update#
Regardless, you will next need to update the documentation with the rst, then youĭon’t need to run the previous command. created or modified a text file with extension. If you edited some documentation directly, i.e. Given in step 2 of Generating the documentation. You need to re-generate the API documentation using “sphinx-apidoc”. If you make changes in your code’s docstrings that you want to see reflected in the generated documentation, To see the tree of API documentation that is generatedĪutomatically from the source code, browse to the “Technical Reference” page and click on the “Modules” link at the Located at “_build/html/index.html” in a web browser. Provided that has all the required options.Īfter these steps are complete, you should be able to preview the HTML documentation by opening the file Generate the tree of API documentation with “sphinx-apidoc”. If using a Conda environment, run conda install -c conda-forge pandocĪlternatively, refer to the installation steps appropriate for your system on pandoc’s websiteĬhange directory to the “docs” subdirectory Instead, use one of the following options:
As pandoc is a standalone tool rather than a Python package, it cannot be installed using pip. To generate a local copy of the documentation for the first time, follow these steps: Generation locally in your development environment so you can preview what will be shown to the users.
#Pip install mongodb how to#
This section describes how to do this same documentation Is generated automatically online for new releases. The project is set up so that Sphinx documentation The documentation will include the docstrings you put on your modules, classes, methods, and functions as wellĪs additional documentation in text files in the “docs” directory. This tool generates nice, indexed, HTML webpages - like this one - from text files in the “docs” directory. The project documentation is created and updated using the Sphinx documentation tool. MongoDB Compass electrolytedb Collections (9/2021) Documentation for developers MongoDB Compass Initial Screen (9/2021) Which would cause the wrong (outdated) version to be present in the environment after installation.ĭownload page for MongoDB community server (9/2021) The -no-cache-dir flag is used to ensure that existing packages are not erroneously reused by pip, To run the WaterTAP test suite, first install the optional testing dependencies using pip: The result should show three collections with some records loaded in Then, select the “electrolytedb” database. You will get a screen like this one (with theĭatabase you are going to click on next circled). Run it, and choose to connect to the server at URL mongodb://localhost:27017 (this
The application called “MongoDB Compass”, which should have been installed when you installed the rest of the Use MongoDB’s graphical user interface, “MongoDB Compass”, to browse the data. Wrote 2 record ( s ) from collection 'base' to file '' If you are going to use WaterTAP’s functionality, but do not plan to contribute to WaterTAP’s codebase, choose this option.Ĭreate a Conda environment (in this example, named watertap) where WaterTAP and its runtime dependencies will be installed: Refer to the Conda installation guide for detailed steps on how to install Conda for your operating system. To use Conda environments, the conda package manager is required. Using Conda environments is not mandatory to be able to install and use WaterTAP however, it is strongly recommended. Once a Conda environment is activated, using the conda activate command in a terminal/console, the environment’s own version of Python will be used to run commands or interactive sessions for the remainder of the session.įor these reasons, Conda environments are especially useful to install and manage multiple projects (and/or multiple versions of the same project) on the same computer with minimal effort,Īs they provide a way to seamlessly switch between different projects without conflicts. Installing WaterTAP Introduction Using Conda environments Ĭonda environments are a way to create and manage multiple sets of packages and/or Python versions on the same system without incurring conflicts.Įach Conda environment is a dedicated directory, separate from other Conda environments and the operating system’s own directories, containing its own collection of packages, executables, and Python installation, including the Python interpreter.