Comments (5)
It would be best of someone could help set up things for me, of course! Once Sphinx is set up I can configure RTD for this.
from resolvelib.
@uranusjr ack... I'll try to get down to something ... FWIW this is the tool we are using it in: https://github.com/nexB/python-inspector
from resolvelib.
@TG1999 ping
from resolvelib.
I am currently mapping the entire public API, to figure out what the documentation needs to look like. Here's what I have at the moment:
resolvelib
AbstractProvider
AbstractProvider.identify()
AbstractProvider.get_preference()
AbstractProvider.find_matches()
AbstractProvider.is_satisfied_by()
AbstractProvider.get_dependencies()
AbstractResolver
AbstractResolver.base_exception
AbstractResolver.__init__()
AbstractResolver.resolve()
BaseReporter
BaseReporter.starting()
BaseReporter.starting_round()
BaseReporter.ending_round()
BaseReporter.ending()
BaseReporter.adding_requirement()
BaseReporter.resolving_conflicts()
BaseReporter.rejecting_candidate()
BaseReporter.pinning()
InconsistentCandidate
InconsistentCandidate.__init__()
Resolver
Resolver.base_exception
Resolver.resolve()
RequirementsConflicted
RequirementsConflicted.__init__()
ResolutionError
ResolutionImpossible
ResolutionImpossible.__init__()
ResolutionTooDeep
ResolutionTooDeep.__init__()
resolvelib.reporters
BaseReporter
BaseReporter.starting()
BaseReporter.starting_round()
BaseReporter.ending_round()
BaseReporter.ending()
BaseReporter.adding_requirement()
BaseReporter.resolving_conflicts()
BaseReporter.rejecting_candidate()
BaseReporter.pinning()
resolvelib.resolvers
Result
Result.mapping
Result.graph
Result.criteria
Result.__new__()
ResolverException
RequirementsConflicted
RequirementsConflicted.__init__()
InconsistentCandidate
InconsistentCandidate.__init__()
ResolutionError
ResolutionImpossible
ResolutionImpossible.__init__()
ResolutionTooDeep
ResolutionTooDeep.__init__()
Resolution
Resolution.__init__()
AbstractResolver
AbstractResolver.base_exception
AbstractResolver.__init__()
AbstractResolver.resolve()
Resolver
Resolver.base_exception
Resolver.resolve()
resolvelib.structs
RequirementInformation
RequirementInformation.requirement
RequirementInformation.parent
RequirementInformation.__new__()
State
State.mapping
State.criteria
State.backtrack_causes
State.__new__()
DirectedGraph
DirectedGraph.__init__()
DirectedGraph.copy()
DirectedGraph.add()
DirectedGraph.remove()
DirectedGraph.connect()
IteratorMapping
IteratorMapping.__init__()
IterableView
build_iter_view()
Criterion
Criterion.__init__()
I don't really enjoy that there's a bunch of thing re-exported at multiple levels and things are being imported (and used) from places where they're not really supposed to be public API.
from resolvelib.
https://readthedocs.org/dashboard/resolvelib/ is a thing, I'll file a PR for adding documentation soon.
from resolvelib.
Related Issues (20)
- 0.8.1: pytest warnings HOT 3
- Typing inconsistency: `AbstractProvider.get_preferences` HOT 1
- Implement lazy consumption of the candidates iterable returned by find_matches() HOT 1
- Sdist releases on pypi.org do not contain files required for tests HOT 2
- Test Failures With Packaging 22.0/23.0 HOT 1
- Drop support for Python prior to 3.7 HOT 3
- Default branch has been renamed to `main` and branch protections enabled
- Resolvelib 0.9.0 passes identifiers to Provider's `get_preference` method without accompanying PreferenceInformation HOT 5
- Please make a new release
- Required Python versions not specified in pip-readable way HOT 1
- 0.9.0: pytest is failing in 6 units HOT 3
- sdist is missing conftest.py HOT 1
- Option to only provide causes of conflict when calling get_preference HOT 2
- An example of resolution failure while it does have a valid resolution. HOT 20
- Awkward wording in docstring for `find_matches()` HOT 5
- Implement Causes Narrowing HOT 1
- Idea: Breadth-first search until reaching breadth level with unpinned requirements
- For n packages there are O(n^2) calls to `_is_current_pin_satisfying` HOT 4
- Use pip-resolver-benchmarks and Pip code to create "real world" resolvelib tests? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from resolvelib.