Skip to content

Commit

Permalink
docs: Mention entry point requirement for eggs #525
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jul 22, 2024
1 parent 4d25ab8 commit fd5e653
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,24 @@ Parameters
the project name
``version`` (required)
the project version

Scrapyd uses the packaging `Version <https://packaging.pypa.io/en/stable/version.html>`__ to interpret the version numbers you provide.
``egg`` (required)
a Python egg containing the project's code

.. note:: Scrapyd uses the `packaging Version <https://packaging.pypa.io/en/stable/version.html>`__ to interpret the version numbers you provide.
The egg must set an entry point to its Scrapy settings. For example, with a ``setup.py`` file:

.. code-block:: python
:emphasize-lines: 5
setup(
name = 'project',
version = '1.0',
packages = find_packages(),
entry_points = {'scrapy': ['settings = projectname.settings']},
)
Do this easily with the `scrapyd-deploy` command from the `scrapyd-client <https://github.com/scrapy/scrapyd-client>`__ package.

Example:

Expand Down

0 comments on commit fd5e653

Please sign in to comment.