Skip to content

Commit 490e84b

Browse files
committed
Update reference to pyproject.lock
1 parent 38b8391 commit 490e84b

File tree

6 files changed

+31
-31
lines changed

6 files changed

+31
-31
lines changed

docs/docs/basic-usage.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Poetry uses this information to search for the right set of files in package "re
5656
in the `tool.poetry.repositories` section, or on [PyPI](https://pypi.org) by default.
5757

5858
Also, instead of modifying the `pyproject.toml` file by hand, you can use the `add` command.
59-
59+
6060
```bash
6161
$ poetry add pendulum
6262
```
@@ -75,50 +75,50 @@ Please read [versions](/versions/) for more in-depth information on versions, ho
7575
!!!note
7676

7777
**How does Poetry download the right files?**
78-
78+
7979
When you specify a dependency in `pyproject.toml`, Poetry first take the name of the package
8080
that you have requested and searches for it in any repository you have registered using the `repositories` key.
8181
If you have not registered any extra repositories, or it does not find a package with that name in the
8282
repositories you have specified, it falls back on PyPI.
83-
83+
8484
When Poetry finds the right package, it then attempts to find the best match
8585
for the version constraint you have specified.
86-
86+
8787

8888
## Installing dependencies
8989

9090
To install the defined dependencies for your project, just run the `install` command.
91-
91+
9292
```bash
9393
poetry install
9494
```
9595

9696
When you run this command, one of two things may happen:
9797

98-
### Installing without `pyproject.lock`
98+
### Installing without `poetry.lock`
9999

100-
If you have never run the command before and there is also no `pyproject.lock` file present,
100+
If you have never run the command before and there is also no `poetry.lock` file present,
101101
Poetry simply resolves all dependencies listed in your `pyproject.toml` file and downloads the latest version of their files.
102102

103-
When Poetry has finished installing, it writes all of the packages and the exact versions of them that it downloaded to the `pyproject.lock` file,
103+
When Poetry has finished installing, it writes all of the packages and the exact versions of them that it downloaded to the `poetry.lock` file,
104104
locking the project to those specific versions.
105-
You should commit the `pyproject.lock` file to your project repo so that all people working on the project are locked to the same versions of dependencies (more below).
105+
You should commit the `poetry.lock` file to your project repo so that all people working on the project are locked to the same versions of dependencies (more below).
106106

107107

108-
### Installing with `pyproject.lock`
108+
### Installing with `poetry.lock`
109109

110-
This brings us to the second scenario. If there is already a `pyproject.lock` file as well as a `pyproject.toml` file
110+
This brings us to the second scenario. If there is already a `poetry.lock` file as well as a `pyproject.toml` file
111111
when you run `poetry install`, it means either you ran the `install` command before,
112-
or someone else on the project ran the `install` command and committed the `pyproject.lock` file to the project (which is good).
112+
or someone else on the project ran the `install` command and committed the `poetry.lock` file to the project (which is good).
113113

114-
Either way, running `install` when a `pyproject.lock` file is present resolves and installs all dependencies that you listed in `pyproject.toml`,
115-
but Poetry uses the exact versions listed in `pyproject.lock` to ensure that the package versions are consistent for everyone working on your project.
114+
Either way, running `install` when a `poetry.lock` file is present resolves and installs all dependencies that you listed in `pyproject.toml`,
115+
but Poetry uses the exact versions listed in `poetry.lock` to ensure that the package versions are consistent for everyone working on your project.
116116
As a result you will have all dependencies requested by your `pyproject.toml` file,
117117
but they may not all be at the very latest available versions
118-
(some of the dependencies listed in the `pyproject.lock` file may have released newer versions since the file was created).
118+
(some of the dependencies listed in the `poetry.lock` file may have released newer versions since the file was created).
119119
This is by design, it ensures that your project does not break because of unexpected changes in dependencies.
120120

121-
### Commit your `pyproject.lock` file to version control
121+
### Commit your `poetry.lock` file to version control
122122

123123
Committing this file to VC is important because it will cause anyone who sets up the project
124124
to use the exact same versions of the dependencies that you are using.
@@ -132,20 +132,20 @@ the dependencies installed are still working even if your dependencies released
132132
!!!note
133133

134134
For libraries it is not necessary to commit the lock file.
135-
135+
136136

137137
## Updating dependencies to their latest versions
138138

139-
As mentioned above, the `pyproject.lock` file prevents you from automatically getting the latest versions
139+
As mentioned above, the `poetry.lock` file prevents you from automatically getting the latest versions
140140
of your dependencies.
141141
To update to the latest versions, use the `update` command.
142142
This will fetch the latest matching versions (according to your `pyproject.toml` file)
143143
and update the lock file with the new versions.
144-
(This is equivalent to deleting the `pyproject.lock` file and running `install` again.)
144+
(This is equivalent to deleting the `poetry.lock` file and running `install` again.)
145145

146146
!!!note
147147

148-
Poetry will display a **Warning** when executing an install command if `pyproject.lock` and `pyproject.toml`
148+
Poetry will display a **Warning** when executing an install command if `poetry.lock` and `pyproject.toml`
149149
are not synchronized.
150150

151151

@@ -159,7 +159,7 @@ or create a brand new one for you to always work isolated from your global Pytho
159159

160160
The created virtualenv will use the Python executable for which
161161
`poetry` has been installed.
162-
162+
163163
What this means is if you project is Python 2.7 only you should
164164
install `poetry` for your global Python 2.7 executable and use
165165
it to manage your project.

docs/docs/cli.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ resolves the dependencies, and installs them.
103103
poetry install
104104
```
105105

106-
If there is a `pyproject.lock` file in the current directory,
106+
If there is a `poetry.lock` file in the current directory,
107107
it will use the exact versions from there instead of resolving them.
108108
This ensures that everyone using the library will get the same versions of the dependencies.
109109

110-
If there is no `pyproject.lock` file, Poetry will create one after dependency resolution.
110+
If there is no `poetry.lock` file, Poetry will create one after dependency resolution.
111111

112112
You can specify to the command that you do not want the development dependencies installed by passing
113113
the `--no-dev` option.
@@ -131,14 +131,14 @@ poetry install -E mysql -E pgsql
131131

132132
## update
133133

134-
In order to get the latest versions of the dependencies and to update the `pyproject.lock` file,
134+
In order to get the latest versions of the dependencies and to update the `poetry.lock` file,
135135
you should use the `update` command.
136136

137137
```bash
138138
poetry update
139139
```
140140

141-
This will resolve all dependencies of the project and write the exact versions into `pyproject.lock`.
141+
This will resolve all dependencies of the project and write the exact versions into `poetry.lock`.
142142

143143
If you just want to update a few packages and not all, you can list them as such:
144144

docs/docs/libraries.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This has many advantages for the end users and allows them to set appropriate
1818

1919
## Lock file
2020

21-
For your library, you may commit the `pyproject.lock` file if you want to.
21+
For your library, you may commit the `poetry.lock` file if you want to.
2222
This can help your team to always test against the same dependency versions.
2323
However, this lock file will not have any effect on other projects that depend on it.
2424
It only has an effect on the main project.
@@ -59,10 +59,10 @@ and you have [configured your credentials](/repositories/#adding-credentials) pr
5959
!!!note
6060

6161
The `publish` command does not execute `build` by default.
62-
62+
6363
If you want to build and publish your packages together,
6464
just pass the `--build` option.
65-
65+
6666
Once this is done, your library will be available to anyone.
6767

6868

poetry/console/commands/install.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class InstallCommand(EnvCommand):
1313
{ --develop=* : Install given packages in development mode. }
1414
"""
1515

16-
help = """The <info>install</info> command reads the <comment>pyproject.lock</> file from
16+
help = """The <info>install</info> command reads the <comment>poetry.lock</> file from
1717
the current directory, processes it, and downloads and installs all the
1818
libraries and dependencies outlined in that file. If the file does not
1919
exist it will look for <comment>pyproject.toml</> and do the same.

poetry/console/commands/lock.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class LockCommand(EnvCommand):
99
"""
1010

1111
help = """The <info>lock</info> command reads the <comment>pyproject.toml</> file from
12-
the current directory, processes it, and locks the depdencies in the <comment>pyproject.lock</> file.
12+
the current directory, processes it, and locks the depdencies in the <comment>poetry.lock</> file.
1313
1414
<info>poetry lock</info>
1515
"""

poetry/puzzle/provider.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def name_for_explicit_dependency_source(self): # type: () -> str
8484

8585
@property
8686
def name_for_locking_dependency_source(self): # type: () -> str
87-
return "pyproject.lock"
87+
return "poetry.lock"
8888

8989
def is_debugging(self):
9090
return self._is_debugging

0 commit comments

Comments
 (0)