Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
flamenco-worker-python
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
blender
flamenco-worker-python
Commits
1fb33788
Commit
1fb33788
authored
8 years ago
by
Sybren A. Stüvel
Browse files
Options
Downloads
Patches
Plain Diff
Clarified some things in the README.md file.
parent
717ea87a
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+9
-5
9 additions, 5 deletions
README.md
with
9 additions
and
5 deletions
README.md
+
9
−
5
View file @
1fb33788
...
...
@@ -6,12 +6,14 @@ Author: Sybren A. Stüvel <sybren@blender.studio>
## Installation
There are a few ways to install Flamenco Worker:
Before you begin, make sure you have Flamenco Manager up and running.
There are two ways to install Flamenco Worker:
-
If you have a distributable zip file (see
[
Packaging for distribution
](
#packaging-for-distribution
)
)
unzip it, then run
`pip install flamenco_worker-xxxx.whl`
unzip it, then run
`pip
3
install flamenco_worker-xxxx.whl`
-
If you have a copy of the source files, run
`pip install -e .`
-
If you have a copy of the source files, run
`pip
3
install -e .`
## Configuration
...
...
@@ -19,7 +21,8 @@ There are a few ways to install Flamenco Worker:
Configuration is read from three locations:
-
A hard-coded default in the Python source code.
-
`flamenco-worker.cfg`
in the current working directory.
-
`flamenco-worker.cfg`
in the current working directory, i.e. the directory that your shell
is in when you invoke the
`flamenco-worker`
command.
-
`$HOME/.flamenco-worker.cfg`
; this file is optional.
The configuration files should be in INI format, as specified by the
...
...
@@ -53,10 +56,11 @@ These configuration keys are also required, but are created automatically in
## Invocation
Install using
`pip install -e .`
for development, or
`setup.py install`
for production.
Install using
`pip
3
install -e .`
for development, or
`
python3
setup.py install`
for production.
This creates a command
`flamenco-worker`
, which can be run with
`--help`
to obtain
a list of possible CLI arguments.
## Registration
If the configuration file does not contain both a
`worker_id`
and
`worker_secret`
, at startup
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment