Skip to content

Commit 1ceb414

Browse files
committed
Merge remote-tracking branch 'nasa/devel' into issue-2457
2 parents d37f86b + 75b30ad commit 1ceb414

File tree

3 files changed

+40
-36
lines changed

3 files changed

+40
-36
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ Learn more about F' key features [here](https://nasa.github.io/fprime/features.h
3131

3232
## Getting Started
3333

34-
To get started with F´, install the F´ toolset with:
34+
To get started with F´, install the F´ bootstrapping tool with:
3535
```
36-
pip install fprime-tools
36+
pip install fprime-bootstrap
3737
```
3838

3939
Then, create a new project with:
4040
```
41-
fprime-util new --project
41+
fprime-bootstrap project
4242
```
4343

4444
See the [HelloWorld Tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/) to guide you through all the steps of developing an F´ project.

docs/INSTALL.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,47 +38,45 @@ Requirements:
3838
> Other OS-specific notes are in the [Troubleshooting](#Troubleshooting) section below.
3939
4040

41+
## Creating a new F´ Project
4142

42-
## Setting Up the Development Environment
43+
The ecosystem of tools supporting F´ is installed as Python packages available via PIP. These packages are installed in a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) by the F´ Bootstrap tool. It is recommended to have one virtual environment per project.
4344

44-
The ecosystem of tools supporting F´ is installed as python packages available via PIP. To setuptools, you should create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/), activate it, and install the latest version of fprime-tools.
45+
### 1. Install theBootstrap tool
4546

46-
1. Create the virtual environment:
47-
48-
```bash
49-
python3 -m venv fprime-venv
47+
The F´ Bootstrap tool is responsible for creating a new F´ project and installing the Python dependencies within the project's virtual environment. Install the fprime-bootstrap tool with:
5048
```
51-
> You should create a new virtual environment for each new F´ project. The name `fprime-venv` may be changed.
52-
53-
2. Activate the virtual environment
54-
55-
```bash
56-
. fprime-venv/bin/activate
49+
pip install fprime-bootstrap
5750
```
58-
> Remember to activate the virtual environment whenever you work with this F´  project.
5951

60-
2. Install F´ tools
61-
```
62-
pip install -U fprime-tools
63-
```
6452
> Some macOS users see an SSL error. [Correct the SSL error](#ssl-error-with-python-37-on-macos) and rerun the above command.
6553
66-
## Creating a New Project
54+
### 2. Create a new project
6755

68-
The entrypoint to developing with F´ is creating a new project. This will clone the F´ repository and install the full tool suite of the specified version for working with the selected version of F´.
56+
The entrypoint to developing with F´ is creating a new project. This will clone the F´ repository and install the full tool suite of the specified version for working with the selected version of F´. To create a new project, run:
6957
```
70-
fprime-util new --project
58+
fprime-bootstrap project
7159
```
7260

7361
This command will ask for some input. Sample responses are below:
7462
```
75-
project_name [MyProject]: MyProject
76-
fprime_branch_or_tag [devel]: devel
77-
Select install_venv:
78-
1 - yes
79-
2 - no
80-
Choose from 1, 2 [1]: 1
63+
[1/1] Project name (MyProject): MyProject
64+
```
65+
66+
This commands perform the following actions:
67+
- Create a new git repository with the standard F´ project structure
68+
- Create a new virtual environment within the project and install dependencies
69+
70+
71+
### 3. Activate the virtual environment
72+
73+
Once the project is created, activate the virtual environment to use the F´ tool suite.
74+
75+
```
76+
cd MyProject
77+
. fprime-venv/bin/activate
8178
```
79+
> Always remember to activate the virtual environment whenever you work with this F´  project.
8280
8381
Next steps: [HelloWorld Tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/)
8482

@@ -105,9 +103,7 @@ This section will add some known hints to trouble-shooting with the installation
105103
If the user is using a virtual environment and receives the 'command not found', the problem is likely caused by the environment not being sourced in a new terminal. Make sure to source the environment before running:
106104

107105
```
108-
. /path/to/venv/bin/activate
109-
e.g.
110-
. $HOME/fprime-venv/bin/activate
106+
. <path/to/project>/fprime-venv/bin/activate
111107
```
112108

113109
If installing without a virtual environment, PIP occasionally uses `$HOME/.local/bin` as a place to install user tools. Users running without virtual environments should add this directory to the path.

docs/UsersGuide/dev/py-dev.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,23 @@
22

33
This guide describes the guidelines for developing Python code to be used with F´. This is done when contributing to the
44
F´ Python code and is recommended for project Python code as well.
5+
Start by cloning the F´ repositories you wish to work on, e.g.
6+
7+
```
8+
git clone https://github.com/fprime-community/fprime-gds
9+
```
510

611
## Required Development Installs
712

813
Setup the virtual environment per the install guide using the small additions below to get the packages F´ uses to
914
facilitate Python development.
1015

1116
```bash
12-
pip install -e fprime/Fw/Python[dev]
13-
pip install -e fprime/Gds/
17+
pip install -e ./fprime-gds
18+
```
19+
or
20+
```
21+
pip install -e ./fprime-tools
1422
```
1523

1624
After you have installed the python packages you need to set up pre-commit hooks using the following command. This
@@ -25,12 +33,12 @@ pre-commit install
2533
Probably one of the most important parts of developing code is to ensure Python unit tests pass. We use pytest:
2634

2735
```bash
28-
cd fprime/Fw/Python/
36+
cd fprime-tools
2937
pytest
3038
```
3139

3240
```bash
33-
cd fprime/Gds/
41+
cd fprime-gds
3442
pytest
3543
```
3644

0 commit comments

Comments
 (0)