Merge branch 'master' into fix-200

.dockerignore

@@ -1,5 +1,4 @@
 build/
-dist/
 htmlcov/
 icloudpd.egg-info
 cron_script.sh

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 5

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,68 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+# ******** NOTE ********
+
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '40 3 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - fix: --only-print-filenames option displays filenames (live photos) of files that have already been downloaded #200
+- fix: docker works on Windows #192
 
 ## 1.7.0 (2020-11-1)
 
@@ -11,6 +12,8 @@
 so all photos will be placed directly into the download directory.
 - fix: Empty directory structure being created #185
 - feature: removed multi-threaded downloading and added deprecation notice to --threads-num parameter #180, #188
+- fix: documentation issues, first adressed in #141 and seperated contribution
+info from README.md into CONTRIBUTING.md
 
 ## 1.6.2 (2020-10-23)
 

CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing iCloud Photos Downloader
+
+Help wanted!  We'd love your contributions to iCloud Photos Downloader. You don't have to know how to code to be able to help!
+
+Please review the following guidelines before contributing.  Also, feel free to propose changes to these guidelines by updating this file and submitting a pull request.
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+There are some requirements for pull requests:
+
+- All bugfixes should be covered (before/after scenario) with a corresponding
+  unit test. All other tests pass. Run `./scripts/test`
+- 100% test coverage also for new features is expected.
+  - After running `./scripts/test`, you will see the test coverage results in the output
+  - You can also open the HTML report at: `./htmlcov/index.html`
+- Code is formatted with [autopep8](https://github.com/hhatto/autopep8). Run `./scripts/format`
+- No [pylint](https://www.pylint.org/) errors. Run `./scripts/lint` (or `pylint icloudpd`)
+- If you've added or changed any command-line options,
+  please update the [Usage](README.md#usage) section in the README.md.
+- Make sure your change is documented in the
+[Unreleased](CHANGELOG.md#unreleased) section in the CHANGELOG.md.
+- We aim to push out a Release once a week (Fridays),  if there is at least one new change in CHANGELOG.
+
+If you need to make any changes to the `pyicloud` library,
+`icloudpd` uses a fork of this library that has been renamed to `pyicloud-ipd`.
+Please clone my [pyicloud fork](https://github.com/icloud-photos-downloader/pyicloud)
+and check out the [pyicloud-ipd](https://github.com/icloud-photos-downloader/pyicloud/tree/pyicloud-ipd)
+branch. PRs should be based on the `pyicloud-ipd` branch and submitted to
+[icloud-photos-downloader/pyicloud](https://github.com/icloud-photos-downloader/pyicloud).
+
+## Setting up te development environment
+
+Install dependencies:
+
+``` sh
+sudo pip install -r requirements.txt
+sudo pip install -r requirements-test.txt
+```
+
+Run tests:
+
+``` sh
+pytest
+```
+
+### Building the Docker image
+
+``` sh
+git clone https://github.com/icloud-photos-downloader/icloud_photos_downloader.git
+cd icloud_photos_downloader
+docker build -t icloudpd/icloudpd .
+```
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team by opening an [issue](https://github.com/icloud-photos-downloader/icloud_photos_downloader/issues/new). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

Dockerfile.release

@@ -10,11 +10,11 @@ RUN set -xe && \
     rm -r /root/.cache
 
 ARG ICLOUDPD_VERSION
-ADD icloudpd-latest-py2.py3-none-any.whl /tmp
+COPY dist/* /tmp
 RUN set -xe \
-  && pip install /tmp/icloudpd-latest-py2.py3-none-any.whl \
+  && pip install /tmp/icloudpd-${ICLOUDPD_VERSION}-py2.py3-none-any.whl \
   && icloudpd --version \
   && icloud -h | head -n1
 
-RUN adduser -D -h /home/user -u 1000 user
-USER user
+# RUN adduser -D -h /home/user -u 1000 user
+# USER user