Release 1.0.0

Author: jdavid

AUTHORS.rst

@@ -6,6 +6,7 @@ Authors::
   Sviatoslav Sydorenko
   Matthias Bartelmeß
   W. Trevor King
+  Robert Coup
   Dave Borowitz
   Brandon Milton
   Daniel Rodríguez Troitiño
@@ -37,6 +38,7 @@ Authors::
   Nicolas Dandrimont
   Raphael Medaer (Escaux)
   Anatoly Techtonik
+  Dan Sully
   David Versmisse
   Mikhail Yushkovskiy
   Robin Stocker
@@ -57,7 +59,6 @@ Authors::
   Nika Layzell
   Peter-Yi Zhang
   Petr Viktorin
-  Robert Coup
   Robert Hölzl
   Ron Cohen
   Thomas Kluyver
@@ -68,6 +69,8 @@ Authors::
   Andrey Devyatkin
   Arno van Lumig
   Ben Davis
+  Colin Watson
+  Drew DeVault
   Dustin Raimondi
   Eric Schrijver
   Greg Fitzgerald
@@ -86,6 +89,7 @@ Authors::
   Kaarel Kitsemets
   Ken Dreyer
   Kevin KIN-FOO
+  Marcel Waldvogel
   Masud Rahman
   Michael Sondergaard
   Natanael Arndt
@@ -111,7 +115,7 @@ Authors::
   Chason Chaffin
   Chris Jerdonek
   Chris Rebert
-  Colin Watson
+  Christopher Hunt
   Cristian Hotea
   Cyril Jouve
   Daniel Bruce
@@ -127,9 +131,11 @@ Authors::
   Erik van Zijst
   Ferengee
   Frazer McLean
+  Gregory Herrero
   Gustavo Di Pietro
   Holger Frey
   Hugh Cole-Baker
+  Isabella Stephens
   Jasper Lievisse Adriaanse
   Jonathan Robson
   Josh Bleecher Snyder
@@ -152,11 +158,12 @@ Authors::
   Rodrigo Bistolfi
   Ross Nicoll
   Rui Abreu Ferreira
+  Saul Pwanson
+  Shane Turner
   Sheeo
   Soasme
   Steven Winfield
   Vladimir Rutsky
   Yu Jianjian
   chengyuhang
   earl
-  Dan Sully

CHANGELOG.rst

@@ -1,4 +1,4 @@
-1.0.0 (UNRELEASED)
+1.0.0 (2019-12-06)
 -------------------------
 
 - Drop Python 2.7 and 3.4 support, six no longer required
@@ -7,25 +7,34 @@
 - Add Python 3.8 support
   `#918 <https://github.com/libgit2/pygit2/issues/918>`_
 
-- New ``Repository.odb`` returns new ``Odb`` type instance. And new
-  ``OdbBackend`` type.
-  `#940 <https://github.com/libgit2/pygit2/pull/940>`_
-  `#942 <https://github.com/libgit2/pygit2/pull/942>`_
-
 - New support for ``/`` operator to traverse trees
   `#903 <https://github.com/libgit2/pygit2/pull/903>`_
   `#924 <https://github.com/libgit2/pygit2/issues/924>`_
 
+- New ``Branch.raw_branch_name``
+  `#954 <https://github.com/libgit2/pygit2/pull/954>`_
+
 - New ``Index.remove_all()``
   `#920 <https://github.com/libgit2/pygit2/pull/920>`_
 
+- New ``Remote.ls_remotes(..)``
+  `#935 <https://github.com/libgit2/pygit2/pull/935>`_
+  `#936 <https://github.com/libgit2/pygit2/issues/936>`_
+
 - New ``Repository.lookup_reference_dwim(..)`` and ``Repository.resolve_refish(..)``
   `#922 <https://github.com/libgit2/pygit2/issues/922>`_
   `#923 <https://github.com/libgit2/pygit2/pull/923>`_
 
-- New ``Remote.ls_remotes(..)``
-  `#935 <https://github.com/libgit2/pygit2/pull/935>`_
-  `#936 <https://github.com/libgit2/pygit2/issues/936>`_
+- New ``Repository.odb`` returns new ``Odb`` type instance. And new
+  ``OdbBackend`` type.
+  `#940 <https://github.com/libgit2/pygit2/pull/940>`_
+  `#942 <https://github.com/libgit2/pygit2/pull/942>`_
+
+- New ``Repository.references.compress()``
+  `#961 <https://github.com/libgit2/pygit2/pull/961>`_
+
+- Optimization: Load notes lazily
+  `#958 <https://github.com/libgit2/pygit2/pull/958>`_
 
 - Fix spurious exception in config
   `#916 <https://github.com/libgit2/pygit2/issues/916>`_

docs/backends.rst

@@ -1,5 +1,5 @@
 **********************************************************************
-Custom backends
+Backends
 **********************************************************************
 
 There is some support for custom backends, but undocumented. See

docs/branches.rst

@@ -0,0 +1,42 @@
+**********************************************************************
+Branches
+**********************************************************************
+
+.. py:attribute:: Repository.branches
+
+Branches inherit from References, and additionally provide specialized
+accessors for some unique features.
+
+.. autoclass:: pygit2.repository.Branches
+   :members:
+   :undoc-members:
+   :special-members: __getitem__, __iter__, __contains__
+
+Example::
+
+    >>> # Listing all branches
+    >>> branches_list = list(repo.branches)
+    >>> # Local only
+    >>> local_branches = list(repo.branches.local)
+    >>> # Remote only
+    >>> remote_branches = list(repo.branches.remote)
+
+    >>> # Get a branch
+    >>> branch = repo.branches['master']
+    >>> other_branch = repo.branches['does-not-exist']  # Will raise a KeyError
+    >>> other_branch = repo.branches.get('does-not-exist')  # Returns None
+
+    >>> remote_branch = repo.branches.remote['upstream/feature']
+
+    >>> # Create a local branch
+    >>> new_branch = repo.branches.local.create('new-branch')
+
+    >>> And delete it
+    >>> repo.branches.delete('new-branch')
+
+
+The Branch type
+====================
+
+.. autoclass:: pygit2.Branch
+   :members:

docs/log.rst docs/commit_log.rst

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.28'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.28.2'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -41,3 +41,8 @@ Example::
 
           >>> f(...)
       """
+
+Running Valgrind
+===================================
+
+valgrind --tool=memcheck --suppressions=misc/valgrind-python.supp ~/Python-3.7.4/bin/pytest

docs/development.rst

@@ -32,24 +32,25 @@ Usage guide:
    :maxdepth: 1
 
    general
-   repository
-   oid
-   objects
 
    backends
    blame
+   branches
+   commit_log
    config
    diff
    features
-   log
+   index_file
    mailmap
    merge
+   oid
+   objects
    references
    remotes
+   repository
    revparse
    settings
    submodule
-   working-copy
    worktree
 
 

docs/index.rst

@@ -1,5 +1,5 @@
 **********************************************************************
-The Index file and the Working copy
+Index file & Working copy
 **********************************************************************
 
 .. autoattribute:: pygit2.Repository.index

docs/working-copy.rst docs/index_file.rst

@@ -90,7 +90,7 @@ History: the 0.x series
 -----------------------
 
 The development of pygit2 started in October 2010, the release of 1.0.0
-happened in November 2019. In the 0.x series the version numbering was
+happened in December 2019. In the 0.x series the version numbering was
 lockstep with libgit2, e.g. pygit2 0.28.x worked with libgit2 0.28.x
 
 

docs/install.rst

@@ -1,5 +1,5 @@
 **********************************************************************
-Git Objects
+Objects
 **********************************************************************
 
 There are four types of Git objects: blobs, trees, commits and tags. For each

docs/objects.rst

@@ -101,54 +101,6 @@ Example. These two lines are equivalent::
 .. autoattribute:: pygit2.Repository.head_is_detached
 .. autoattribute:: pygit2.Repository.head_is_unborn
 
-Branches
-====================
-
-.. py:attribute:: Repository.branches
-
-Branches inherit from References, and additionally provide specialized
-accessors for some unique features.
-
-.. autoclass:: pygit2.repository.Branches
-   :members:
-   :undoc-members:
-   :special-members: __getitem__, __iter__, __contains__
-
-Example::
-
-    >>> # Listing all branches
-    >>> branches_list = list(repo.branches)
-    >>> # Local only
-    >>> local_branches = list(repo.branches.local)
-    >>> # Remote only
-    >>> remote_branches = list(repo.branches.remote)
-
-    >>> # Get a branch
-    >>> branch = repo.branches['master']
-    >>> other_branch = repo.branches['does-not-exist']  # Will raise a KeyError
-    >>> other_branch = repo.branches.get('does-not-exist')  # Returns None
-
-    >>> remote_branch = repo.branches.remote['upstream/feature']
-
-    >>> # Create a local branch
-    >>> new_branch = repo.branches.local.create('new-branch')
-
-    >>> And delete it
-    >>> repo.branches.delete('new-branch')
-
-
-The Branch type
-====================
-
-.. autoattribute:: pygit2.Branch.branch_name
-.. autoattribute:: pygit2.Branch.remote_name
-.. autoattribute:: pygit2.Branch.upstream
-.. autoattribute:: pygit2.Branch.upstream_name
-.. automethod:: pygit2.Branch.rename
-.. automethod:: pygit2.Branch.delete
-.. automethod:: pygit2.Branch.is_head
-.. automethod:: pygit2.Branch.is_checked_out
-
 The reference log
 ====================
 

docs/references.rst

@@ -1,5 +1,5 @@
 **********************************************************************
-The repository
+Repository
 **********************************************************************
 
 Everything starts either by creating a new repository, or by opening an

docs/repository.rst

@@ -35,7 +35,7 @@
 #
 # The version number of pygit2
 #
-__version__ = '0.28.2'
+__version__ = '1.0.0'
 
 
 #